Conventions The Caddy ecosystem adheres to a few conventions to make things consistent and intuitive across the platform. Network addresses Placeholders File locations Data directory Configuration directory Durations Network addresses When specifying a network address to dial or bind, Caddy accepts a string in the following format: network/address The network part is optional (defaulting to tcp), and is anything that Go's net.Dial function recognizes. If a network is specified, a single forward slash / must separate the network and address portions. The network can be any of the following; ones suffixed with 4 or 6 are IPv4 or IPv6 only, respectively: TCP: tcp, tcp4, tcp6 UDP: udp, udp4, udp6 IP: ip, ip4, ip6 Unix: unix, unixgram, unixpacket The address part may be any of these forms: host host:port :port [ipv6%zone]:port /path/to/unix/socket /path/to/unix/socket|0200 The host may be any hostname, resolvable domain name, or IP address. In the case of IPv6 addresses, the address must be enclosed in square brackets []. The zone identifier (starting with %) is optional (often used for link-local addresses). The port may be a single value (:8080) or an inclusive range (:8080-8085). A port range will be multiplied into singular addresses. Not all config fields accept port ranges. The special port :0 means any available port. A unix socket path is only acceptable when using a unix* network type. The forward slash that separates the network and address is not considered part of the path. When a unix socket is used as a bind address, you may optionally specify a file permission mode after the path, separated by a pipe |. The default is 0200 (octal), i.e. u=w,g=,o= (symbolic). The leading 0 is optional. Valid examples: :8080 127.0.0.1:8080 localhost:8080 localhost:8080-8085 tcp/localhost:8080 tcp/localhost:8080-8085 udp/localhost:9005 [::1]:8080 tcp6/[fe80::1%eth0]:8080 unix//path/to/socket unix//path/to/socket|0200 Placeholders Caddy's configuration supports the use of placeholders. Using placeholders is a simple way to inject dynamic values into a static configuration. Placeholders are bounded on either side by curly braces { } and contain the identifier inside, for example: {foo.bar}. The opening placeholder brace can be escaped \{like.this} to prevent replacement. Placeholder identifiers are typically namespaced with dots to avoid collisions across modules. Which placeholders are available depends on the context. Not all placeholders are available in all parts of the config. For example, the HTTP app sets placeholders that are only available in areas of the config related to handling HTTP requests. The following placeholders are always available (global): Placeholder Description {env.*} Environment variable; example: {env.HOME} {file.*} Contents from a file; example: {file./path/to/secret.txt} {system.hostname} The system's local hostname {system.slash} The system's filepath separator {system.os} The system's OS {system.arch} The system's architecture {system.wd} The current working directory {time.now} The current time as a Go Time struct {time.now.http} The current time in the format used in HTTP headers {time.now.unix} The current time as a unix timestamp in seconds {time.now.unix_ms} The current time as a unix timestamp in milliseconds {time.now.common_log} The current time in Common Log Format {time.now.year} The current year in YYYY format Not all config fields support placeholders, but most do where you would expect it. Support for placeholders needs to have been explicitly added to those fields. Plugin authors can read this article to learn how to add support for placeholders in their own modules. File locations This section contains information about where to find various files. File and directory paths described here are defaults at best; some can be overridden. Your config files There is no single, conventional place for you to put your config files. Put them wherever makes the most sense to you. Distributions that ship with a default config file should document where this config file is at, even if it might be obvious to the package/distro maintainers. For most Linux installations, the Caddyfile will be found at /etc/caddy/Caddyfile. Data directory Caddy stores TLS certificates and other important assets in a data directory, which is backed by the configured storage module (default: local file system). If the XDG_DATA_HOME environment variable is set, it is $XDG_DATA_HOME/caddy. Otherwise, its path varies by platform, adhering to OS conventions: OS Data directory path Linux, BSD $HOME/.local/share/caddy Windows %AppData%\Caddy macOS $HOME/Library/Application Support/Caddy Plan 9 $HOME/lib/caddy Android $HOME/caddy (or /sdcard/caddy) All other OSes use the Linux/BSD directory path. The data directory must not be treated as a cache. Its contents are not ephemeral or merely for the sake of performance. Caddy stores TLS certificates, private keys, OCSP staples, and other necessary information to the data directory. It should not be purged without understanding the implications. It is crucial that this directory is persistent and writeable by Caddy. Configuration directory This is where Caddy may store certain configuration to disk. Most notably, it persists the last active configuration (by default) to this folder for easy resumption later using caddy run --resume. If the XDG_CONFIG_HOME environment variable is set, it is $XDG_CONFIG_HOME/caddy. Otherwise, its path varies by platform, adhering to OS conventions: OS Config directory path Linux, BSD $HOME/.config/caddy Windows %AppData%\Caddy macOS $HOME/Library/Application Support/Caddy Plan 9 $HOME/lib/caddy All other OSes use the Linux/BSD directory path. It is crucial that this directory is persistent and writeable by Caddy. Durations Duration strings are commonly used throughout Caddy's configuration. They take on the same format as Go's time.ParseDuration syntax except you can also use d for day (we assume 1 day = 24 hours for simplicity). Valid units are: ns (nanosecond) us/µs (microsecond) ms (millisecond) s (second) m (minute) h (hour) d (day) Examples: 250ms 5s 1.5h 2h45m 90d In the JSON config, duration values can also be integers which represent nanoseconds.
Project
