jolheiser
/
vanity
1
0
Fork 0
Code Issues Pull Requests Releases 5 Activity
Go Vanity URLs
5 Commits
2 Branches
5 Tags
740 KiB
Go 85.5%
CSS 13.8%
Dockerfile 0.7%
 
 
 
Go to file
jolheiser 35b809dc85
Better config options, change package structure 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 		2020-09-11 20:38:18 -05:00
api Better config options, change package structure 2020-09-11 20:38:18 -05:00
docker Better config options, change package structure 2020-09-11 20:38:18 -05:00
flags Better config options, change package structure 2020-09-11 20:38:18 -05:00
router Better config options, change package structure 2020-09-11 20:38:18 -05:00
service Better config options, change package structure 2020-09-11 20:38:18 -05:00
.gitignore Initial Overhaul 2020-09-10 12:27:46 -05:00
Makefile Better config options, change package structure 2020-09-11 20:38:18 -05:00
README.md Better config options, change package structure 2020-09-11 20:38:18 -05:00
go.mod Add GitLab support 2020-09-10 13:43:38 -05:00
go.sum Add GitLab support 2020-09-10 13:43:38 -05:00
main.go Better config options, change package structure 2020-09-11 20:38:18 -05:00
vanity.service Initial Overhaul 2020-09-10 12:27:46 -05:00

README.md

Vanity

A simple web service to serve vanity Go imports. Feel free to check it out using my instance.

Configuration

When choosing a service, the default base-url will be the default server of that service:

Service Default
Gitea https://gitea.com
GitHub https://github.com
GitLab https://gitlab.com

Configuration will be set, in order of priority

  1. Flags
  2. Environment
  3. Config file
NAME:
   vanity - Vanity Go Imports

USAGE:
   vanity [global options] command [command options] [arguments...]

VERSION:
   0.1.0+3-g6d7150e

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value     Path to a config file [$VANITY_CONFIG]
   --port value       Port to run the vanity server on (default: 7777) [$VANITY_PORT]
   --domain value     Vanity domain, e.g. go.domain.tld [$VANITY_DOMAIN]
   --service value    Service type (Gitea, GitHub, GitLab) (default: "gitea") [$VANITY_SERVICE]
   --base-url value   Base URL to service [$VANITY_BASE_URL]
   --namespace value  Owner namespace [$VANITY_NAMESPACE]
   --token value      Access token [$VANITY_TOKEN]
   --include value    Repository names to include (regex) [$VANITY_INCLUDE]
   --exclude value    Repository names to exclude (regex) [$VANITY_EXCLUDE]
   --private          Include private repositories (default: false) [$VANITY_PRIVATE]
   --fork             Include forked repositories (default: false) [$VANITY_FORK]
   --mirror           Include mirrored repositories (default: false) [$VANITY_MIRROR]
   --archive          Include archived repositories (default: false) [$VANITY_ARCHIVE]
   --override value   Repository name to override (NAME=OVERRIDE) [$VANITY_OVERRIDE]
   --interval value   Interval between updating repositories (default: 15m0s) [$VANITY_INTERVAL]
   --debug            Debug logging (default: false) [$VANITY_DEBUG]
   --help, -h         show help (default: false)
   --version, -v      print the version (default: false)

Vanity also supports git-import.

Docker

docker run \
    --env VANITY_DOMAIN=go.domain.tld \
    --env VANITY_NAMESPACE=<jolheiser> \
    --env VANITY_TOKEN=<token> \
    --publish 80:7777 \
    --restart always
    jolheiser/vanity:latest

Overrides

Certain modules may not align perfectly with their repository name.

Overrides are available via config or by setting an environment variable VANITY_OVERRIDE_PACKAGE=NAME

Config-only Mode

To run Vanity in config-only mode for packages, set --service to off.