diff options
| author | Marc Pervaz Boocha <mboocha@sudomsg.com> | 2025-07-27 15:43:06 +0530 |
|---|---|---|
| committer | Marc Pervaz Boocha <mboocha@sudomsg.com> | 2025-07-27 15:43:06 +0530 |
| commit | 41178f6bad1f2e1eaed462475cb7aa26185dc0ac (patch) | |
| tree | 8c025140c6d1d35d02246ea413b135da93021532 /README.md | |
| download | gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar.gz gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar.bz2 gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar.lz gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar.xz gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.tar.zst gopkgserver-41178f6bad1f2e1eaed462475cb7aa26185dc0ac.zip | |
Initial Commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..16f4b75 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# GOPKGSERVER + +A minimal Go server for serving vanity URLs, configurable via TOML. + +## Status + +**Alpha** — functional but rough. No tests yet. Interface and config format may change. + +## Features + +- Serves vanity URLs for `go get` +- Configurable with TOML +- Supports VCS repositories (e.g., git) +- Custom directory and file view URLs + +## Usage + +```bash +gopkgserver -config /path/to/config.toml +``` + +## Configuration + +Configuration is passed via the -config flag as a TOML file. Example structure: + +``` toml +[server] +address = ":6000" + +[repo."go.example.com/cache"] +repo = "https://git.example.com/mirror/cache.git" +vcs = "git" +home = "-" +directory = "https://git.example.com/mirror/cache.git/tree/{/dir}" +file = "https://git.example.com/cache/mirror/cache.git/tree/{/dir}/{file}#n{line}" +``` + |