A tiny HTTP server for supporting custom Golang import paths (vanity urls for Go packages)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
James Mills ce87061a1d
Update Drone CI to publish to Docker Hub
3 weeks ago
.github/workflows Use go embed for templates (#50) 3 weeks ago
templates Use go embed for templates (#50) 3 weeks ago
.codecov.yml Set up CI (#45) 4 months ago
.dockerignore Add dockerfiles and update makefile (#25) 5 years ago
.drone.yml Update Drone CI to publish to Docker Hub 3 weeks ago
.gitignore Fix project structure, docker image and build/dev experience 3 weeks ago
CHANGELOG.md Back to development 2 years ago
Dockerfile Fix project structure, docker image and build/dev experience 3 weeks ago
LICENSE Initial commit 5 years ago
Makefile Fix project structure, docker image and build/dev experience 3 weeks ago
README.md Update install instructions 3 weeks ago
config.go Allow setting branch (#46) 4 months ago
config_test.go Allow setting branch (#46) 4 months ago
go.mod Update module import path to go.mills.io/sally 3 weeks ago
go.sum Fix godoc badge image (#43) 2 years ago
handler.go Update module import path to go.mills.io/sally 3 weeks ago
handler_test.go Update Godoc server to pkg.go.dev (#40) 2 years ago
main.go Update module import path to go.mills.io/sally 3 weeks ago
sally Fix project structure, docker image and build/dev experience 3 weeks ago
sally.yaml Starting point (#1) 5 years ago
tools.go template: Bundle in binary with bindata (#36) 3 years ago
utils_test.go Add dockerfiles and update makefile (#25) 5 years ago
version.go Fix project structure, docker image and build/dev experience 3 weeks ago
version_test.go Fix project structure, docker image and build/dev experience 3 weeks ago

README.md

sally

Build Status

A tiny HTTP server for supporting custom Golang import paths

Installation

Using Go:

go install go.mills.io/sally@latest

Using Docker:

docker pull prologic/sally

Usage

Create a YAML file with the following structure:

# 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

Or using Docker:

docker run -p 8080:8080 -v /path/to/sally.yaml:/sally.yaml prologic/sally