{"id":18907188,"url":"https://github.com/42atomys/vanity-go","last_synced_at":"2025-10-29T11:49:45.766Z","repository":{"id":104032955,"uuid":"459112251","full_name":"42atomys/vanity-go","owner":"42atomys","description":"Vanity URL for your Go package at production scale","archived":false,"fork":false,"pushed_at":"2023-02-24T15:21:30.000Z","size":126,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T05:51:20.268Z","etag":null,"topics":["docker-image","go","golang","kubernetes","proxy","simple-app","vanity-url"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/42atomys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null},"funding":{"github":["42Atomys"]}},"created_at":"2022-02-14T10:19:37.000Z","updated_at":"2025-03-03T21:23:05.000Z","dependencies_parsed_at":"2023-07-13T00:30:08.123Z","dependency_job_id":null,"html_url":"https://github.com/42atomys/vanity-go","commit_stats":null,"previous_names":["42atomys/go-proxy"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/42atomys/vanity-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/42atomys%2Fvanity-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/42atomys%2Fvanity-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/42atomys%2Fvanity-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/42atomys%2Fvanity-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/42atomys","download_url":"https://codeload.github.com/42atomys/vanity-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/42atomys%2Fvanity-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281616669,"owners_count":26531918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-29T02:00:06.901Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-image","go","golang","kubernetes","proxy","simple-app","vanity-url"],"created_at":"2024-11-08T09:20:01.169Z","updated_at":"2025-10-29T11:49:45.732Z","avatar_url":"https://github.com/42atomys.png","language":"Go","funding_links":["https://github.com/sponsors/42Atomys"],"categories":[],"sub_categories":[],"readme":"# VanityGO : Vanity import paths for Go package\n\n[![Release 🎉](https://github.com/42Atomys/vanity-go/actions/workflows/release.yaml/badge.svg)](https://github.com/42Atomys/vanity-go/actions/workflows/release.yaml)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/42atomys/vanity-go?label=last%20release)\n![GitHub contributors](https://img.shields.io/github/contributors/42Atomys/vanity-go?color=blueviolet)\n![GitHub Repo stars](https://img.shields.io/github/stars/42atomys/vanity-go?color=blueviolet)\n[![Docker Pull](https://img.shields.io/docker/pulls/atomys/vanity-go)](https://hub.docker.com/r/atomys/vanity-go)\n[![Docker Pull](https://img.shields.io/docker/image-size/atomys/vanity-go)](https://hub.docker.com/r/atomys/vanity-go)\n\nSimple go application that allows you to share your code with a custom domain name instead of github or gitlab links or other git protocols.\n\nSay goodbye to `github.com/42Atomys/vanity-go` imports. Say hello to `atomys.codes/vanity-go` imports 🎉\n\n\nWhen choosing a domain, keep in mind that it will be the name of your package for the foreseeable future, so choose a name that you’ll still like tomorrow.\nPeople tend to choose domains with `.io`, `.codes` and `.dev` TLDs for their pacakges/software projects these days.\n\n## Motivation\n\nAt 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!\n\nError 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.\n\nWith [webhooked](https://github.com/42Atomys/webhooked) project, I told myself that I didn't want to redo everything, so I put this repo online\n\n## Usage\n\n### Step 1 : Configuration file\n```yaml\n# API Version also used to protect against API or Schema changes\n# Actually, the available API versions are: 1\napiVersion: 1\n# List of your proxies\n# You can add as many proxies as you want with logic:\n# 1 proxy per final domain\nproxies:\n- # namespace is the domain name used for following entries\n  # This can be a subdomain, a domain or a full domain name\n  # subdomain.example.org, example.org or example.org/subdomain\n  namespace: atomys.codes\n  # All entries of this namespace will be proxied to the following address\n  # Key are the name and the entrypoint/path of your proxied packages\n  # Value is the current URL of your package. The Destination URL must\n  # end with a valid protocol.\n  # Allowed protocol are: \"bzr\", \"fossil\", \"git\", \"hg\", \"svn\".\n  entries:\n    # Root redirection can be catch with \"-\" or \"/\" as key\n    # Will responds to the following URL: atomys.codes\n    -: https://github.com/42Atomys/vanity-go.git\n    # Redirect go-get import to atomys.codes/vanity-go\n    vanity-go: https://github.com/42Atomys/vanity-go.git\n    # Redirect go-get import to atomys.codes/webhooked\n    webhooked: https://github.com/42Atomys/webhooked.git\n    # Redirect go-get import to atomys.codes/dns-updater\n    dns-updater: https://github.com/42Atomys/dns-updater.git\n    # Redirect go-get import to atomys.codes/subpath/gw2api-go\n    sdk/gw2api-go: https://gitlab.com/Atomys/gw2api-go.git\n```\n\n### Step 2: Launch it 🚀\n\n\u003e **TIPS**: When you create your routing, configure it to only take into account the query params `go-get=1` to follow the GoLang directive (https://pkg.go.dev/cmd/go#hdr-Remote_import_paths)\n\n### With Kubernetes\n\nIf you want to use kubernetes, for production or personnal use, refere to example/kubernetes:\n\nhttps://github.com/42Atomys/vanity-go/tree/main/examples/kubernetes\n\n\n### With Docker image\n\nYou can use the docker image [atomys/vanity-go](https://hub.docker.com/r/atomys/vanity-go) in a very simplistic way\n\n```sh\n# Basic launch instruction using the default configuration path\ndocker run -it --rm -p 8080:8080 -v ${PWD}/myconfig.yaml:/config/vanity.yaml atomys/vanity-go:latest\n# Use custom configuration file\ndocker run -it --rm -p 8080:8080 -v ${PWD}/myconfig.yaml:/myconfig.yaml atomys/vanity-go:latest serve --config /myconfig.yaml\n```\n\n### With pre-builded binary\n\n```sh\n./vanity-go serve --config config.yaml -p 8080\n```\n\n## To-Do\n\nTO-Do is moving on Project Section: https://github.com/42Atomys/vanity-go/projects?type=beta\n\n# Contribution\n\nAll pull requests and issues on GitHub will welcome.\n\nAll contributions are welcome :)\n\n## Thanks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F42atomys%2Fvanity-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F42atomys%2Fvanity-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F42atomys%2Fvanity-go/lists"}