go-vanity

Vanity import paths for Go modules, as a Cloudflare Worker written in Go.

import "go.example.com/foo" instead of github.com/me/foo.

Use your domains instead of coupl(e)ing your code to GitHub.

It is a net/http handler compiled with TinyGo and served through workers-go. Run this code as a plain Go binary anywhere else.

It serves

request	response
/<module>[/pkg...]?go-get=1	go-import and go-source meta tags for <host>/<module>
/<module>[/pkg...]	a page with the go get line, source and docs links, and the same tags; or a 302 with browser
/	an index of the modules, or a 302 to index_redirect
anything else	404

Prefixes match whole path segments, longest first, so tools and tools/x can be different repositories. Major-version subdirectories (/v2) need no entry: the go-import prefix is the repository root and go reads the rest from go.mod.

A module's own go.mod has to declare the vanity path (module go.example.com/foo) for this to work.

Configuration

A JSON document, described by config.schema.json.

For example,

{
  "title": "go.example.com",
  "modules": {
    "foo": "https://github.com/me/foo",
    "tools/bar": { "repo": "https://codeberg.org/me/bar", "branch": "trunk", "description": "Bar." },
    "private": { "repo": "https://git.example.com/me/private", "source": "none" }
  }
}

serves go get compatible meta tags pointing go.example.com/foo to https://github.com/me/foo.

Deploying

Each release contains the built Worker: worker.mjs, runtime.mjs, wasm_exec.js, and app.wasm together in go-vanity-worker.tar.gz.

Cloudflare

Put your config under [vars.CONFIG] in wrangler.toml and your hostname in routes, unpack a release into build/ (or run ./build.sh), and wrangler deploy.

Anywhere else

CONFIG="$(cat config.json)" PORT=8080 go run .

Development

nix develop
go test ./...
./build.sh && wrangler dev