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.
 
 
 
 
xuu 86045e3ce9
continuous-integration/drone/push Build is failing Details
refactor: cleanup and update libs (#1)
4 weeks ago
.github/workflows Use go embed for templates (#50) 2 years ago
templates Use go embed for templates (#50) 2 years ago
.codecov.yml Set up CI (#45) 2 years ago
.dockerignore Add dockerfiles and update makefile (#25) 6 years ago
.drone.yml Update Drone CI to publish to Docker Hub 2 years ago
.gitignore Fix project structure, docker image and build/dev experience 2 years ago
CHANGELOG.md Back to development 3 years ago
Dockerfile Fix project structure, docker image and build/dev experience 2 years ago
LICENSE Initial commit 7 years ago
Makefile refactor: cleanup and update libs (#1) 4 weeks ago
README.md Update install instructions 2 years ago
config.go refactor: cleanup and update libs (#1) 4 weeks ago
config_test.go Allow setting branch (#46) 2 years ago
go.mod refactor: cleanup and update libs (#1) 4 weeks ago
go.sum refactor: cleanup and update libs (#1) 4 weeks ago
handler.go Update module import path to go.mills.io/sally 2 years ago
handler_test.go Update Godoc server to pkg.go.dev (#40) 3 years ago
main.go Update module import path to go.mills.io/sally 2 years ago
sally.yaml Starting point (#1) 7 years ago
tools.go refactor: cleanup and update libs (#1) 4 weeks ago
utils_test.go refactor: cleanup and update libs (#1) 4 weeks ago
version.go Fix project structure, docker image and build/dev experience 2 years ago
version_test.go Fix project structure, docker image and build/dev experience 2 years 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