pub

package module

v0.1.13 Latest Latest Go to latest Published: Jan 25, 2024 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/btwiuse/pub

Links

Open Source Insights

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 specified port:
$ pub :8080

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

# 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/

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

View Source

var Usage string

Functions ¶

func ApplyRules ¶ added in v0.1.10

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

func Handler ¶ added in v0.1.10

func Handler(rules Rules) http.Handler

func InferPrefix ¶ added in v0.1.12

func InferPrefix(s string) string

func Run ¶

func Run(args []string) error

func SplitPathPrefix ¶ added in v0.1.12

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

Types ¶

type Rule ¶ added in v0.1.10

type Rule struct {
	Resource string
	Path     string
	Prefix   string
}

func NewRule ¶ added in v0.1.10

func NewRule(res, path_with_prefix string) Rule

type Rules ¶ added in v0.1.10

type Rules []Rule

func Parse ¶ added in v0.1.10

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

func (*Rules) Push ¶ added in v0.1.10

func (s *Rules) Push(r Rule)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
pub command
handler
libpub

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