caddy: Index | Examples | Files | Directories

package caddy

import ""

Package caddy implements the Caddy server manager.

To use this package:

1. Set the AppName and AppVersion variables.
2. Call LoadCaddyfile() to get the Caddyfile.
   Pass in the name of the server type (like "http").
   Make sure the server type's package is imported
   (import _ "").
3. Call caddy.Start() to start Caddy. You get back
   an Instance, on which you can call Restart() to
   restart it or Stop() to stop it.

You should call Wait() on your instance to wait for all servers to quit before your process exits.



Package Files

assets.go caddy.go commands.go controller.go plugins.go rlimit_posix.go sigtrap.go sigtrap_posix.go upgrade.go


var (
    // AppName is the name of the application.
    AppName string

    // AppVersion is the version of the application.
    AppVersion string

    // Quiet mode will not show any informative output on initialization.
    Quiet bool

    // PidFile is the path to the pidfile to create.
    PidFile string

    // GracefulTimeout is the maximum duration of a graceful shutdown.
    GracefulTimeout time.Duration

Configurable application parameters

var (
    // DefaultConfigFile is the name of the configuration file that is loaded
    // by default if no other file is specified.
    DefaultConfigFile = "Caddyfile"
var OnProcessExit []func()

OnProcessExit is a list of functions to run when the process exits -- they are ONLY for cleanup and should not block, return errors, or do anything fancy. They will be run with every signal, even if "shutdown callbacks" are not executed. This variable must only be modified in the main goroutine from init() functions.

func AssetsPath Uses

func AssetsPath() string

AssetsPath returns the path to the folder where the application may store data. If CADDYPATH env variable is set, that value is used. Otherwise, the path is the result of evaluating "$HOME/.caddy".

func DescribePlugins Uses

func DescribePlugins() string

DescribePlugins returns a string describing the registered plugins.

func EmitEvent Uses

func EmitEvent(event EventName, info interface{})

EmitEvent executes the different hooks passing the EventType as an argument. This is a blocking function. Hook developers should use 'go' keyword if they don't want to block Caddy.

func HasListenerWithAddress Uses

func HasListenerWithAddress(addr string) bool

HasListenerWithAddress returns whether this package is tracking a server using a listener with the address addr.

func IsInternal Uses

func IsInternal(addr string) bool

IsInternal returns true if the IP of addr belongs to a private network IP range. addr must only be an IP or an IP:port combination. Loopback addresses are considered false.

func IsLoopback Uses

func IsLoopback(addr string) bool

IsLoopback returns true if the hostname of addr looks explicitly like a common local hostname. addr must only be a host or a host:port combination.

func IsUpgrade Uses

func IsUpgrade() bool

IsUpgrade returns true if this process is part of an upgrade where a parent caddy process spawned this one to upgrade the binary.

func ListPlugins Uses

func ListPlugins() map[string][]string

ListPlugins makes a list of the registered plugins, keyed by plugin type.

func RegisterCaddyfileLoader Uses

func RegisterCaddyfileLoader(name string, loader Loader)

RegisterCaddyfileLoader registers loader named name.

func RegisterEventHook Uses

func RegisterEventHook(name string, hook EventHook)

RegisterEventHook plugs in hook. All the hooks should register themselves and they must have a name.

func RegisterParsingCallback Uses

func RegisterParsingCallback(serverType, afterDir string, callback ParsingCallback)

RegisterParsingCallback registers callback to be called after executing the directive afterDir for server type serverType.

func RegisterPlugin Uses

func RegisterPlugin(name string, plugin Plugin)

RegisterPlugin plugs in plugin. All plugins should register themselves, even if they do not perform an action associated with a directive. It is important for the process to know which plugins are available.

The plugin MUST have a name: lower case and one word. If this plugin has an action, it must be the name of the directive that invokes it. A name is always required and must be unique for the server type.

func RegisterServerType Uses

func RegisterServerType(typeName string, srv ServerType)

RegisterServerType registers a server type srv by its name, typeName.

func SetDefaultCaddyfileLoader Uses

func SetDefaultCaddyfileLoader(name string, loader Loader)

SetDefaultCaddyfileLoader registers loader by name as the default Caddyfile loader if no others produce a Caddyfile. If another Caddyfile loader has already been set as the default, this replaces it.

Do not call RegisterCaddyfileLoader on the same loader; that would be redundant.

func SplitCommandAndArgs Uses

func SplitCommandAndArgs(command string) (cmd string, args []string, err error)

SplitCommandAndArgs takes a command string and parses it shell-style into the command and its separate arguments.


var commandLine string
var command string
var args []string

// just for the test - change GOOS and reset it at the end of the test
runtimeGoos = "windows"
defer func() {
    runtimeGoos = runtime.GOOS

commandLine = `mkdir /P "C:\Program Files"`
command, args, _ = SplitCommandAndArgs(commandLine)

fmt.Printf("Windows: %s: %s [%s]\n", commandLine, command, strings.Join(args, ","))

// set GOOS to linux
runtimeGoos = "linux"

commandLine = `mkdir -p /path/with\ space`
command, args, _ = SplitCommandAndArgs(commandLine)

fmt.Printf("Linux: %s: %s [%s]\n", commandLine, command, strings.Join(args, ","))


Windows: mkdir /P "C:\Program Files": mkdir [/P,C:\Program Files]
Linux: mkdir -p /path/with\ space: mkdir [-p,/path/with space]

func Started Uses

func Started() bool

Started returns true if at least one instance has been started by this package. It never gets reset to false once it is set to true.

func Stop Uses

func Stop() error

Stop stops ALL servers. It blocks until they are all stopped. It does NOT execute shutdown callbacks, and it deletes all instances after stopping is completed. Do not re-use any references to old instances after calling Stop.

func TrapSignals Uses

func TrapSignals()

TrapSignals create signal handlers for all applicable signals for this system. If your Go program uses signals, this is a rather invasive function; best to implement them yourself in that case. Signals are not required for the caddy package to function properly, but this is a convenient way to allow the user to control this part of your program.

func Upgrade Uses

func Upgrade() error

Upgrade re-launches the process, preserving the listeners for a graceful upgrade. It does NOT load new configuration; it only starts the process anew with the current config. This makes it possible to perform zero-downtime binary upgrades.

TODO: For more information when debugging, see:

func ValidDirectives Uses

func ValidDirectives(serverType string) []string

ValidDirectives returns the list of all directives that are recognized for the server type serverType. However, not all directives may be installed. This makes it possible to give more helpful error messages, like "did you mean ..." or "maybe you need to plug in ...".

func ValidateAndExecuteDirectives Uses

func ValidateAndExecuteDirectives(cdyfile Input, inst *Instance, justValidate bool) error

ValidateAndExecuteDirectives will load the server blocks from cdyfile by parsing it, then execute the directives configured by it and store the resulting server blocks into inst. If justValidate is true, parse callbacks will not be executed between directives, since the purpose is only to check the input for valid syntax.

type AfterStartup Uses

type AfterStartup interface {

AfterStartup is an interface that can be implemented by a server type that wants to run some code after all servers for the same Instance have started.

type CaddyfileInput Uses

type CaddyfileInput struct {
    Filepath       string
    Contents       []byte
    ServerTypeName string

CaddyfileInput represents a Caddyfile as input and is simply a convenient way to implement the Input interface.

func (CaddyfileInput) Body Uses

func (c CaddyfileInput) Body() []byte

Body returns c.Contents.

func (CaddyfileInput) Path Uses

func (c CaddyfileInput) Path() string

Path returns c.Filepath.

func (CaddyfileInput) ServerType Uses

func (c CaddyfileInput) ServerType() string

ServerType returns c.ServerType.

type Context Uses

type Context interface {
    // Called after the Caddyfile is parsed into server
    // blocks but before the directives are executed,
    // this method gives you an opportunity to inspect
    // the server blocks and prepare for the execution
    // of directives. Return the server blocks (which
    // you may modify, if desired) and an error, if any.
    // The first argument is the name or path to the
    // configuration file (Caddyfile).
    // This function can be a no-op and simply return its
    // input if there is nothing to do here.
    InspectServerBlocks(string, []caddyfile.ServerBlock) ([]caddyfile.ServerBlock, error)

    // This is what Caddy calls to make server instances.
    // By this time, all directives have been executed and,
    // presumably, the context has enough state to produce
    // server instances for Caddy to start.
    MakeServers() ([]Server, error)

Context is a type which carries a server type through the load and setup phase; it maintains the state between loading the Caddyfile, then executing its directives, then making the servers for Caddy to manage. Typically, such state involves configuration structs, etc.

type Controller Uses

type Controller struct {

    // Key is the key from the top of the server block, usually
    // an address, hostname, or identifier of some sort.
    Key string

    // OncePerServerBlock is a function that executes f
    // exactly once per server block, no matter how many
    // hosts are associated with it. If it is the first
    // time, the function f is executed immediately
    // (not deferred) and may return an error which is
    // returned by OncePerServerBlock.
    OncePerServerBlock func(f func() error) error

    // ServerBlockIndex is the 0-based index of the
    // server block as it appeared in the input.
    ServerBlockIndex int

    // ServerBlockKeyIndex is the 0-based index of this
    // key as it appeared in the input at the head of the
    // server block.
    ServerBlockKeyIndex int

    // ServerBlockKeys is a list of keys that are
    // associated with this server block. All these
    // keys, consequently, share the same tokens.
    ServerBlockKeys []string

    // ServerBlockStorage is used by a directive's
    // setup function to persist state between all
    // the keys on a server block.
    ServerBlockStorage interface{}
    // contains filtered or unexported fields

Controller is given to the setup function of directives which gives them access to be able to read tokens with which to configure themselves. It also stores state for the setup functions, can get the current context, and can be used to identify a particular server block using the Key field.

func NewTestController Uses

func NewTestController(serverType, input string) *Controller

NewTestController creates a new Controller for the server type and input specified. The filename is "Testfile". If the server type is not empty and is plugged in, a context will be created so that the results of setup functions can be checked for correctness.

Used only for testing, but exported so plugins can use this for convenience.

func (*Controller) Context Uses

func (c *Controller) Context() Context

Context gets the context associated with the instance associated with c.

func (*Controller) Get Uses

func (c *Controller) Get(key interface{}) interface{}

Get safely gets a value from the Instance's storage.

func (*Controller) OnFinalShutdown Uses

func (c *Controller) OnFinalShutdown(fn func() error)

OnFinalShutdown adds fn to the list of callback functions to execute when the server is about to be shut down NOT as part of a restart.

func (*Controller) OnFirstStartup Uses

func (c *Controller) OnFirstStartup(fn func() error)

OnFirstStartup adds fn to the list of callback functions to execute when the server is about to be started NOT as part of a restart.

func (*Controller) OnRestart Uses

func (c *Controller) OnRestart(fn func() error)

OnRestart adds fn to the list of callback functions to execute when the server is about to be restarted.

func (*Controller) OnShutdown Uses

func (c *Controller) OnShutdown(fn func() error)

OnShutdown adds fn to the list of callback functions to execute when the server is about to be shut down (including restarts).

func (*Controller) OnStartup Uses

func (c *Controller) OnStartup(fn func() error)

OnStartup adds fn to the list of callback functions to execute when the server is about to be started (including restarts).

func (*Controller) ServerType Uses

func (c *Controller) ServerType() string

ServerType gets the name of the server type that is being set up.

func (*Controller) Set Uses

func (c *Controller) Set(key, val interface{})

Set safely sets a value on the Instance's storage.

type CtxKey Uses

type CtxKey string

CtxKey is a value type for use with context.WithValue.

type EventHook Uses

type EventHook func(eventType EventName, eventInfo interface{}) error

EventHook is a type which holds information about a startup hook plugin.

type EventName Uses

type EventName string

EventName represents the name of an event used with event hooks.

const (
    StartupEvent         EventName = "startup"
    ShutdownEvent        EventName = "shutdown"
    CertRenewEvent       EventName = "certrenew"
    InstanceStartupEvent EventName = "instancestartup"

Define names for the various events

type GracefulServer Uses

type GracefulServer interface {

    // Address returns the address the server should
    // listen on; it is used to pair the server to
    // its listener during a graceful/zero-downtime
    // restart. Thus when implementing this method,
    // you must not access a listener to get the
    // address; you must store the address the
    // server is to serve on some other way.
    Address() string

GracefulServer is a Server and Stopper, the stopping of which is graceful (whatever that means for the kind of server being implemented). It must be able to return the address it is configured to listen on so that its listener can be paired with it upon graceful restarts. The net.Listener that a GracefulServer creates must implement the Listener interface for restarts to be graceful (assuming the listener is for TCP).

type Input Uses

type Input interface {
    // Gets the Caddyfile contents
    Body() []byte

    // Gets the path to the origin file
    Path() string

    // The type of server this input is intended for
    ServerType() string

Input represents a Caddyfile; its contents and file path (which should include the file name at the end of the path). If path does not apply (e.g. piped input) you may use any understandable value. The path is mainly used for logging, error messages, and debugging.

func CaddyfileFromPipe Uses

func CaddyfileFromPipe(f *os.File, serverType string) (Input, error)

CaddyfileFromPipe loads the Caddyfile input from f if f is not interactive input. f is assumed to be a pipe or stream, such as os.Stdin. If f is not a pipe, no error is returned but the Input value will be nil. An error is only returned if there was an error reading the pipe, even if the length of what was read is 0.

func DefaultInput Uses

func DefaultInput(serverType string) Input

DefaultInput returns the default Caddyfile input to use when it is otherwise empty or missing. It uses the default host and port (depends on host, e.g. localhost is 2015, otherwise 443) and root.

func LoadCaddyfile Uses

func LoadCaddyfile(serverType string) (Input, error)

LoadCaddyfile loads a Caddyfile by calling the plugged in Caddyfile loader methods. An error is returned if more than one loader returns a non-nil Caddyfile input. If no loaders load a Caddyfile, the default loader is used. If no default loader is registered or it returns nil, the server type's default Caddyfile is loaded. If the server type does not specify any default Caddyfile value, then an empty Caddyfile is returned. Consequently, this function never returns a nil value as long as there are no errors.

type Instance Uses

type Instance struct {

    // storing values on an instance is preferable to
    // global state because these will get garbage-
    // collected after in-process reloads when the
    // old instances are destroyed; use StorageMu
    // to access this value safely
    Storage   map[interface{}]interface{}
    StorageMu sync.RWMutex
    // contains filtered or unexported fields

Instance contains the state of servers created as a result of calling Start and can be used to access or control those servers. It is literally an instance of a server type. Instance values should NOT be copied. Use *Instance for safety.

func Instances Uses

func Instances() []*Instance

Instances returns the list of instances.

func Start Uses

func Start(cdyfile Input) (*Instance, error)

Start starts Caddy with the given Caddyfile.

This function blocks until all the servers are listening.

func (*Instance) Caddyfile Uses

func (i *Instance) Caddyfile() Input

Caddyfile returns the Caddyfile used to create i.

func (*Instance) Restart Uses

func (i *Instance) Restart(newCaddyfile Input) (*Instance, error)

Restart replaces the servers in i with new servers created from executing the newCaddyfile. Upon success, it returns the new instance to replace i. Upon failure, i will not be replaced.

func (*Instance) SaveServer Uses

func (i *Instance) SaveServer(s Server, ln net.Listener)

SaveServer adds s and its associated listener ln to the internally-kept list of servers that is running. For saved servers, graceful restarts will be provided.

func (*Instance) Servers Uses

func (i *Instance) Servers() []ServerListener

Servers returns the ServerListeners in i.

func (*Instance) ShutdownCallbacks Uses

func (i *Instance) ShutdownCallbacks() []error

ShutdownCallbacks executes all the shutdown callbacks of i, including ones that are scheduled only for the final shutdown of i. An error returned from one does not stop execution of the rest. All the non-nil errors will be returned.

func (*Instance) Stop Uses

func (i *Instance) Stop() error

Stop stops all servers contained in i. It does NOT execute shutdown callbacks.

func (*Instance) Wait Uses

func (i *Instance) Wait()

Wait blocks until all of i's servers have stopped.

type Listener Uses

type Listener interface {
    File() (*os.File, error)

Listener is a net.Listener with an underlying file descriptor. A server's listener should implement this interface if it is to support zero-downtime reloads.

type Loader Uses

type Loader interface {
    Load(serverType string) (Input, error)

Loader is a type that can load a Caddyfile. It is passed the name of the server type. It returns an error only if something went wrong, not simply if there is no Caddyfile for this loader to load.

A Loader should only load the Caddyfile if a certain condition or requirement is met, as returning a non-nil Input value along with another Loader will result in an error. In other words, loading the Caddyfile must be deliberate & deterministic, not haphazard.

The exception is the default Caddyfile loader, which will be called only if no other Caddyfile loaders return a non-nil Input. The default loader may always return an Input value.

type LoaderFunc Uses

type LoaderFunc func(serverType string) (Input, error)

LoaderFunc is a convenience type similar to http.HandlerFunc that allows you to use a plain function as a Load() method.

func (LoaderFunc) Load Uses

func (lf LoaderFunc) Load(serverType string) (Input, error)

Load loads a Caddyfile.

type PacketConn Uses

type PacketConn interface {
    File() (*os.File, error)

PacketConn is a net.PacketConn with an underlying file descriptor. A server's packetconn should implement this interface if it is to support zero-downtime reloads (in sofar this holds true for datagram connections).

type ParsingCallback Uses

type ParsingCallback func(Context) error

ParsingCallback is a function that is called after a directive's setup functions have been executed for all the server blocks.

type Plugin Uses

type Plugin struct {
    // ServerType is the type of server this plugin is for.
    // Can be empty if not applicable, or if the plugin
    // can associate with any server type.
    ServerType string

    // Action is the plugin's setup function, if associated
    // with a directive in the Caddyfile.
    Action SetupFunc

Plugin is a type which holds information about a plugin.

type Server Uses

type Server interface {

Server is a type that can listen and serve. It supports both TCP and UDP, although the UDPServer interface can be used for more than just UDP.

If the server uses TCP, it should implement TCPServer completely. If it uses UDP or some other protocol, it should implement UDPServer completely. If it uses both, both interfaces should be fully implemented. Any unimplemented methods should be made as no-ops that simply return nil values.

type ServerListener Uses

type ServerListener struct {
    // contains filtered or unexported fields

ServerListener pairs a server to its listener and/or packetconn.

func (ServerListener) Addr Uses

func (s ServerListener) Addr() net.Addr

Addr returns the listener's network address. It returns nil when it is not set.

func (ServerListener) LocalAddr Uses

func (s ServerListener) LocalAddr() net.Addr

LocalAddr returns the local network address of the packetconn. It returns nil when it is not set.

type ServerType Uses

type ServerType struct {
    // Function that returns the list of directives, in
    // execution order, that are valid for this server
    // type. Directives should be one word if possible
    // and lower-cased.
    Directives func() []string

    // DefaultInput returns a default config input if none
    // is otherwise loaded. This is optional, but highly
    // recommended, otherwise a blank Caddyfile will be
    // used.
    DefaultInput func() Input

    // The function that produces a new server type context.
    // This will be called when a new Caddyfile is being
    // loaded, parsed, and executed independently of any
    // startup phases before this one. It's a way to keep
    // each set of server instances separate and to reduce
    // the amount of global state you need.
    NewContext func(inst *Instance) Context

ServerType contains information about a server type.

type SetupFunc Uses

type SetupFunc func(c *Controller) error

SetupFunc is used to set up a plugin, or in other words, execute a directive. It will be called once per key for each server block it appears in.

func DirectiveAction Uses

func DirectiveAction(serverType, dir string) (SetupFunc, error)

DirectiveAction gets the action for directive dir of server type serverType.

type Stopper Uses

type Stopper interface {
    // Stop stops the server. It blocks until the
    // server is completely stopped.
    Stop() error

Stopper is a type that can stop serving. The stop does not necessarily have to be graceful.

type TCPServer Uses

type TCPServer interface {
    // Listen starts listening by creating a new listener
    // and returning it. It does not start accepting
    // connections. For UDP-only servers, this method
    // can be a no-op that returns (nil, nil).
    Listen() (net.Listener, error)

    // Serve starts serving using the provided listener.
    // Serve must start the server loop nearly immediately,
    // or at least not return any errors before the server
    // loop begins. Serve blocks indefinitely, or in other
    // words, until the server is stopped. For UDP-only
    // servers, this method can be a no-op that returns nil.
    Serve(net.Listener) error

TCPServer is a type that can listen and serve connections. A TCPServer must associate with exactly zero or one net.Listeners.

type UDPServer Uses

type UDPServer interface {
    // ListenPacket starts listening by creating a new packetconn
    // and returning it. It does not start accepting connections.
    // TCP-only servers may leave this method blank and return
    // (nil, nil).
    ListenPacket() (net.PacketConn, error)

    // ServePacket starts serving using the provided packetconn.
    // ServePacket must start the server loop nearly immediately,
    // or at least not return any errors before the server
    // loop begins. ServePacket blocks indefinitely, or in other
    // words, until the server is stopped. For TCP-only servers,
    // this method can be a no-op that returns nil.
    ServePacket(net.PacketConn) error

UDPServer is a type that can listen and serve packets. A UDPServer must associate with exactly zero or one net.PacketConns.


caddyhttp/basicauthPackage basicauth implements HTTP Basic Authentication for Caddy.
caddyhttp/browsePackage browse provides middleware for listing files in a directory when directory path is requested instead of a specific file.
caddyhttp/errorsPackage errors implements an HTTP error handling middleware.
caddyhttp/extensionsPackage extensions contains middleware for clean URLs.
caddyhttp/fastcgiPackage fastcgi has middleware that acts as a FastCGI client.
caddyhttp/gzipPackage gzip provides a middleware layer that performs gzip compression on the response.
caddyhttp/headerPackage header provides middleware that appends headers to requests based on a set of configuration rules that define which routes receive which headers.
caddyhttp/httpserverPackage httpserver implements an HTTP server on top of Caddy.
caddyhttp/internalsrvPackage internalsrv provides a simple middleware that (a) prevents access to internal locations and (b) allows to return files from internal location by setting a special header, e.g.
caddyhttp/logPackage log implements request (access) logging middleware.
caddyhttp/markdownPackage markdown is middleware to render markdown files as HTML on-the-fly.
caddyhttp/proxyPackage proxy is middleware that proxies HTTP requests.
caddyhttp/redirectPackage redirect is middleware for redirecting certain requests to other locations.
caddyhttp/rewritePackage rewrite is middleware for rewriting requests internally to a different path.
caddyhttp/staticfilesPackage staticfiles provides middleware for serving static files from disk.
caddyhttp/statusPackage status is middleware for returning status code for requests
caddyhttp/templatesPackage templates implements template execution for files to be dynamically rendered for the client.
caddyhttp/websocketPackage websocket implements a WebSocket server by executing a command and piping its input and output through the WebSocket connection.
caddytlsPackage caddytls facilitates the management of TLS assets and integrates Let's Encrypt functionality into Caddy with first-class support for creating and renewing certificates automatically.
caddytls/storagetestPackage storagetest provides utilities to assist in testing caddytls.Storage implementations.
telemetryPackage telemetry implements the client for server-side telemetry of the network.

Package caddy imports 23 packages (graph). Updated 2018-07-18. Refresh now. Tools for package owners. This is an inactive package (no imports and no commits in at least two years).