summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 16f4b7572fc74bc77a3ebf2ee5757e865d4793ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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}"
```