Sign inSign up

atomys/vanity-go

By atomys

•Updated over 4 years ago

Image
0

317

atomys/vanity-go repository overview

⁠# VanityGO : Vanity import paths for Go package

Release 🎉 GitHub release (latest by date) GitHub contributors GitHub Repo stars Docker Pull Docker Pull

Simple go application that allows you to share your code with a custom domain name instead of github or gitlab links or other git protocols.

Say goodbye to github.com/42Atomys/vanity-go imports. Say hello to atomys.codes/vanity-go imports 🎉

⁠Motivation

At the beginning to clarify my code especially with gitlab and subfolders (ex: gitlab.com/subgroup-a/subgroup-b/subgroup-n/project) importing files was not sexy. And a problem occurred when the folder architecture changed!

Error 404 in all directions, in all repositories. I created a classic index.html file but having to connect to a server to do vim (sorry emacs) is very annoying.

With 42Stellar⁠ project, I told myself that I didn't want to redo everything, so I put this repo online

⁠Usage

⁠Step 1 : Configuration file
# API Version also used to protect against API or Schema changes
# Actually, the available API versions are: 1
apiVersion: 1
# List of your proxies
# You can add as many proxies as you want with logic:
# 1 proxy per final domain
proxies:
- # namespace is the domain name used for following entries
  # This can be a subdomain, a domain or a full domain name
  # subdomain.example.org, example.org or example.org/subdomain
  namespace: atomys.codes
  # All entries of this namespace will be proxied to the following address
  # Key are the name and the entrypoint/path of your proxied packages
  # Value is the current URL of your package. The Destination URL must
  # end with a valid protocol.
  # Allowed protocol are: "bzr", "fossil", "git", "hg", "svn".
  entries:
    # Redirect go-get import to atomys.codes/vanity-go
    vanity-go: https://github.com/42Atomys/vanity-go.git
    # Redirect go-get import to atomys.codes/dns-updater
    dns-updater: https://github.com/42Atomys/dns-updater.git
    # Redirect go-get import to atomys.codes/subpath/gw2api-go
    subpath/gw2api-go: https://gitlab.com/Atomys/gw2api-go.git
⁠Step 2: Launch it 🚀
⁠With Docker image

You can use the docker image atomys/vanity-go⁠ in a very simplistic way

Basic launch instruction using the default configuration path

docker run -it --rm -p 8080:8080 -v ${PWD}/myconfig.yaml:/config/goproxy.yaml atomys/vanity-go:latest

Or use a custom configuration file

docker run -it --rm -p 8080:8080 -v ${PWD}/myconfig.yaml:/myconfig.yaml atomys/vanity-go:latest serve --config /myconfig.yaml

Tag summary

Content type

Image

Digest

Size

8.5 MB

Last updated

over 4 years ago

docker pull atomys/vanity-go