aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6c97d53b7ba2064bc337f16d36c52784c2045735 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# go-import-redirect

A thing that tells `go get` where to get Go packages and redirects users
to https://godoc.org. It runs on AWS Lambda, but can easily be adapted
to run elsewhere.

You need to set up the following environment variables for it to work:

* `DEST` for the base URL that will be used to build the repository URL,
* `PREFIX` for the prefix that must be removed from your package name,
  e.g. `golang.org/x/` for `golang.org/x/image`, and
* `VCS` for the type of VCS you are using, e.g. `git`.

Additionally, the version under `gcp/` will use:

* `ADDR` for the address to listen on, defaulting to every address, and
* `PORT` for the port to listen on, defaulting to 8080.

See https://golang.org/pkg/net/#Dial for details of the address format.

If `ADDR` is set and starts with `/`, go-import-redirect will treat it
as the path of a UNIX socket to create and listen on. `PORT` is also
ignored.