pub

README

NAME

pub - Publish anything to the open web

SYNOPSIS

pub [res1 path1]... [resN [pathN]]

DESCRIPTION

The pub command accepts an optional sequence of resource-path pairs, where resource could be any file, dir, port or url, and path specifies the mountpoint of the resource.

For each pair, the path is mandatory except for the last resource (resN). When the path is omitted, it defaults to "/".

In the special case of N=1, pub README.md / could be simplified to pub README.md.

EXAMPLES

# Publish a directory at the default path:
$ pub .

# Publish a dir at subpath:
$ pub /tmp/ /temp/

# Publish a specified port:
$ pub :8080

# Publish a URL at the default path:
$ pub https://example.com

# Publish a URL at the default path while restricting the request method to GET:
$ pub https://example.com 'GET /'

# Publish at a port with a specified path, followed by a URL at the default path:
$ pub \
  :9944 /rpc/ws \
  https://polkadot.js.org/apps/

SEE ALSO

• https://pkg.go.dev/github.com/btwiuse/pub

Documentation

Index

• Variables
• func ApplyRules(mux *http.ServeMux, rules Rules)
• func Handler(rules Rules) http.Handler
• func InferPrefix(pattern string) string
• func RelayAddr() string
• func Run(args []string) error
• func SplitPathPrefix(pp string) (pattern, pfx string)
• type Rule
  • func NewRule(res, pattern_with_prefix string) Rule
• type Rules
  • func Parse(s []string) (rules Rules)
  • func (s *Rules) Push(r Rule)

Variables

var Usage string

Functions

func ApplyRules

func ApplyRules(mux *http.ServeMux, rules Rules)

func Handler

func Handler(rules Rules) http.Handler

func InferPrefix

func InferPrefix(pattern string) string

func RelayAddr

func RelayAddr() string

func Run

func Run(args []string) error

func SplitPathPrefix

func SplitPathPrefix(pp string) (pattern, pfx string)

Types

type Rule

type Rule struct {
	Resource string
	Pattern  string
	Prefix   string
}

func NewRule

func NewRule(res, pattern_with_prefix string) Rule

type Rules

type Rules []Rule

func Parse

func Parse(s []string) (rules Rules)

func (*Rules) Push

func (s *Rules) Push(r Rule)