plugin

Documentation

Index

• type DNSRegister
• type Gateway
• type Log
• type Nginx
• type Router

Types

type DNSRegister

type DNSRegister interface {
	GetExternalAddress() (net.IP, error)
	RegisterAddress(host, user, password string, addr net.IP, offline bool) error
}

DNSRegister provides a mechanism to register DNS records to a remote dynamic DNS service

type Gateway

type Gateway interface {
	// Return the prefix for this gateway
	Prefix() string

	// Return the middleware in order, which is called from left to right, then right to left,
	// on the serving of the route
	Middleware() []string
}

Gateway provides a set of routes and middleware which is applied to those routes

type Log

type Log interface {
	// Print log message
	Print(context.Context, ...interface{})

	// Format and print log message
	Printf(context.Context, string, ...interface{})
}

Log plugin

type Nginx

type Nginx interface {
	// Test configuration, return error if it fails
	Test() error

	// Test the configuration and then reload it (the SIGHUP signal)
	Reload() error

	// Reopen log files (the SIGUSR1 signal)
	Reopen() error
}

Nginx provides a forked nginx instance, with the ability to reopen log files and reload the configuration

type Router

type Router interface {
	http.Handler
}

Router is a task which maps paths to routes