Categorygithub.com/zxfishhack/sally
modulepackage
1.1.3
Repository: https://github.com/zxfishhack/sally.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
16
Dependents
0
Files
372 SLOC

# README

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:

# 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

# Functions

Asset loads and returns the asset for the given name.
AssetDir returns the file names below a certain directory embedded in the file by go-bindata.
AssetInfo loads and returns the asset info for the given name.
AssetNames returns the names of the assets.
CreateHandler creates a Sally http.Handler.
MustAsset is like Asset but panics when Asset would return an error.
Parse takes a path to a yaml file and produces a parsed Config.
RestoreAsset restores an asset under the given directory.
RestoreAssets restores an asset under the given directory recursively.

# Structs

Config represents the structure of the yaml file.
Package details the options available for each repo.