aethergate

README

aethergate

Overview

aethergate is a tool that generates static files to support vanity Go remote import paths.

With aethergate, you can use vanity remote import paths like import example.com/pkg while hosting your code on platforms such as GitHub, GitLab, or SourceHut. Each repository defined in the aethergate.toml file generates an index.html file containing go-import meta tags, which redirect the go tool to the actual repository.

The generated HTML is fully customizable using a layout.html template and is automatically minified to optimize bandwidth usage.

Install

go install go.endfield.ltd/aethergate@latest

Contributing

Send patches to the mailing list , report bugs on the issue tracker.

License

Apache 2.0 only, see LICENSE.

Documentation

Overview

aethergate is a tool that generates static files to support vanity Go remote import paths.

It allows you to create vanity remote import paths like `import example.com/pkg` while hosting your code on platforms such as GitHub, GitLab, or SourceHut. Each repository defined in the `aethergate.toml` configuration file generates an `index.html` file containing `go-import` meta tags, which redirect the go tool to the actual repository.

Usage:

aethergate <command>

Commands:

init
	Initialize the configuration and layout template files.

build [<output-dir>]
	Build the static site. Optionally specify an output directory (default: `dist`).

Customization:

aethergate.toml
	The configuration file, generated with the `init` command, includes documentation for each field. Use it to define your vanity imports.

layout.html
	The HTML template for generating pages. Available template actions:

	{{.MetaTags}}: Outputs the required meta tags for Go imports.
	{{.Domain}}: The domain of the import path.
	{{.Path}}: The path component of the import.
	{{.VCS}}: The version control system (e.g., git, hg).
	{{.Repo}}: The repository URL.