https://github.com/lafronzt/vanago
A Vanity Go Import Path Web Server
https://github.com/lafronzt/vanago
go go-import go-import-redirector go-web-server golang vanity vanity-address
Last synced: 5 months ago
JSON representation
A Vanity Go Import Path Web Server
- Host: GitHub
- URL: https://github.com/lafronzt/vanago
- Owner: lafronzt
- License: mit
- Created: 2020-03-15T02:17:34.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T15:08:26.000Z (over 3 years ago)
- Last Synced: 2024-11-18T18:24:41.868Z (over 1 year ago)
- Topics: go, go-import, go-import-redirector, go-web-server, golang, vanity, vanity-address
- Language: Go
- Size: 13.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vanago
By Tyler La Fronz
`go get go.lafronz.com/vanago`
## Status
[](https://codeclimate.com/github/lafronzt/vanago/maintainability)
## Description
Vanago is a simple webserver that allows anyone to host custom vanity urls for their Go import paths.
## How to Use
1. Set the Environment variables:
| Name | Default | Description |
|------|---------|-------------|
| PORT | 8080 | Port to Open Server On |
| vcsBase | https://github.com | URL base that your Git Repos are hosted on |
| vcsTeamName | lafronzt | Team or User Name |
| vcsLinkMiddle | / | used to separate the team name from the repo name |
| projectName | Personal | Used to Log the Project name in requests |
| indexRedirect | http://TylerLaFronz.com | URL to redirect the naked index request to |
2. Run the server
```bash
go install go.lafronz.com/vanago/cmd/vanago
```
## Why I made it
As part of my push to have a better understand of Go, I started reading about how the `go get` command works.
After learning how it functioned, I was searching around for any tool that would allow me to customize my go import paths.
I was unable to find anything that really fit my needs or was dynamic enough for me to use for both public and private packages.
So I created Vanago, which I now use to run my Go import path.
### Future
I am looking to expand this in the future to support multiple Teams/Users on the same URL.