Documentation
¶
Overview ¶
Package config contains utilities and types necessary for launching specially-configured server instances.
Index ¶
Constants ¶
View Source
const ( DefaultHost = "0.0.0.0" DefaultPort = "2015" DefaultRoot = "." // The default configuration file to load if none is specified DefaultConfigFile = "Caddyfile" )
Variables ¶
View Source
var ( Host = DefaultHost Port = DefaultPort )
Host and Port are configurable via command line flag
Functions ¶
func IsNotFound ¶
IsNotFound returns whether or not the error is one which indicates that the configuration file was not found. (Useful for checking the error returned from Load).
Types ¶
type Config ¶
type Config struct {
// The hostname or IP on which to serve
Host string
// The port to listen on
Port string
// The directory from which to serve files
Root string
// HTTPS configuration
TLS TLSConfig
// Middleware stack
Middleware map[string][]middleware.Middleware
// Functions (or methods) to execute at server start; these
// are executed before any parts of the server are configured,
// and the functions are blocking
Startup []func() error
// Functions (or methods) to execute when the server quits;
// these are executed in response to SIGINT and are blocking
Shutdown []func() error
// The path to the configuration file from which this was loaded
ConfigFile string
}
config represents a server configuration. It is populated by parsing a config file (via the Load function).
func Default ¶
func Default() []Config
Default makes a default configuration that's empty except for root, host, and port, which are essential for serving the cwd.
Click to show internal directories.
Click to hide internal directories.