sally

command module
v0.0.0-...-415a882 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2024 License: MIT Imports: 9 Imported by: 0

README

sally

sally is a small HTTP service you can host to serve vanity import paths for Go modules.

Installation

To build sally from source, use:

go install go.uber.org/sally@latest

Alternatively, get a pre-built Docker image from https://github.com/uber-go/sally/pkgs/container/sally.

Usage

Create a YAML file with the following structure:

# sally.yaml

# Configures documentation linking.
# Optional.
godoc:
  # Host for the Go documentation server.
  # Defaults to pkg.go.dev.
  host: pkg.go.dev

# Base URL for your package site.
# If you want your modules available under "example.com",
# specify example.com here.
# This field is required.
url: go.uber.org

# Collection of packages under example.com
# and their Git repositories.
packages:

  # The key is the name of the package following the base URL.
  # For example, if you want to make a package available at
  # "example.com/foo", you'd specify "foo" here.
  zap:
    # Path to the Git repository.
    #
    # This field is required.
    repo: github.com/uber-go/zap

    # Optional description of the package.
    description: A fast, structured-logging library.

    # Alternative base URL instead of the value configured at the top-level.
    # This is useful if the same sally instance is
    # hosted behind multiple base URLs.
    #
    # Defaults to the value of the top-level url field.
    url: example.com

Run sally like so:

$ sally

This will read from sally.yaml and serve on port 8080. To use a different port and/or configuration file, use the -yml and -port flags.

$ sally -yml site.yaml -port 5000
Custom Templates

You can provide your own custom templates. For this, create a directory with .html templates and provide it via the -templates flag. You only need to provide the templates you want to override. See templates for the available templates.

Documentation

Overview

sally is an HTTP service that allows you to serve vanity import paths for your Go packages.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL