aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4cafea2fcfdf1d157feeb404c8b25939859742bd (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
# sally

A tiny HTTP server for supporting custom Golang import paths

## Installation

`go get go.uber.org/sally`

## Usage

Create a YAML file with the following structure:

```yaml
# This optional section configures godoc documentation linking.
godoc:
  # Instance of godoc server used for documentation links. Defaults to pkg.go.dev.
  host: pkg.go.dev

url: google.golang.org
packages:
  grpc:
    repo: github.com/grpc/grpc-go
```

Then run Sally to start the HTTP server:

```
$ sally -yml site.yaml -port 5000
```