Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
ci
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

kkn.fi/vanity

Build Status GoDoc](https://pkg.go.dev/kkn.fi/vanity) GoReportCard

Concepts

  • VCS is Version Control System (such as 'git')
  • Repo root is the root path the source code repository (such as 'https://github.com/kare')
  • Domain is the internet address where the Go Vanity server is hosted (such as 9fans.net or kkn.fi). Domain is deduced from HTTP request.
  • Path is the path component of the Go package (such as /cmd/tcpproxy in kkn.fi/cmd/tcpproxy)

Features

  • Redirects Go tool to VCS
  • Redirects browsers to pkg.go.dev module server by default. Module Server URL is configurable.
  • Module server URL options are.
  • Redirects HTTP to HTTPS
  • Automatic configuration of packages:
    • All packages are redirected with full path to vcsroot.
    • Packages whose path is prefixed with "/cmd/" redirect automatically to vcsroot by stripping the "/cmd" prefix from the package path. Example: Redirect request "kkn.fi/cmd/tcpproxy" to "github.com/kare/tcpproxy"
  • Configurable logger which is fully compatible with standard log package. Stdout is default.
  • Supports index HTML file in the domain root and configurable static content directory (for images, CSS, and etc).

Installation

go get kkn.fi/vanity

Specification