13 KiB
| title |
|---|
| Caddyfile Concepts |
Caddyfile Concepts
This document will help you learn about the HTTP Caddyfile in detail.
Structure
The Caddyfile's structure can be described visually:
Key points:
- An optional global options block can be the very first thing in the file.
- Otherwise, the first line of the Caddyfile is always the address(es) of the site to serve.
- All directives and matchers must go in a site block. There is no global scope or inheritance across site blocks.
- If there is only one site block, its curly braces
{ }are optional.
A Caddyfile consists of at least one or more site blocks, which always starts with one or more addresses for the site. Any directives appearing before the address will be confusing to the parser.
Blocks
Opening and closing a block is done with curly braces:
... {
...
}
- The open curly brace
{must be at the end of its line and preceded by a space. - The close curly brace
}must be on its own line.
When there is only one site block, the curly braces (and indentation) are optional. This is for convenience to quickly define a single site, for example, this:
localhost
reverse_proxy /api/* localhost:9001
file_server
is equivalent to:
localhost {
reverse_proxy /api/* localhost:9001
file_server
}
when you have only a single site block; it's a matter of preference.
To configure multiple sites with the same Caddyfile, you must use curly braces around each one to separate their configurations:
example1.com {
root * /www/example.com
file_server
}
example2.com {
reverse_proxy localhost:9000
}
If a request matches multiple site blocks, the site block with the most specific matching address is chosen. Requests don't cascade into to other site blocks.
Directives
Directives are functional keywords which customize how the site is served. They must appear within site blocks. For example, a complete file server config might look like this:
localhost
file_server
Or a reverse proxy:
localhost
reverse_proxy localhost:9000
In these examples, file_server and reverse_proxy are directives. Directives are the first word on a line in a site block.
In the second example, localhost:9000 is an argument because it appears on the same line after the directive.
Sometimes directives can open their own blocks. Subdirectives appear on the beginning of each line within directive blocks:
localhost
reverse_proxy localhost:9000 localhost:9001 {
lb_policy first
}
Here, lb_policy is a subdirective to reverse_proxy (it sets the load balancing policy to use between backends).
Unless otherwise documented, directives cannot be used within other directive blocks. For example, basicauth cannot be used within file_server because the file server does not know how to do authentication; but you can use directives within route, handle, and handle_path blocks because they are specifically designed to group directives together.
Note that when the HTTP Caddyfile is adapted, HTTP handler directives are sorted according to a specific default directive order unless in a route block, so the order of appearance of the directives does not matter except in route blocks.
Tokens and quotes
The Caddyfile is lexed into tokens before being parsed. Whitespace is significant in the Caddyfile, because tokens are separated by whitespace.
Often, directives expect a certain number of arguments; if a single argument has a value with whitespace, it would be lexed as two separate tokens:
directive abc def
This could be problematic and return errors or unexpected behavior.
If abc def is supposed to be the value of a single argument, it needs to be quoted:
directive "abc def"
Quotes can be escaped if you need to use quotes in quoted tokens, too:
directive "\"abc def\""
To avoid escaping quotes, you can instead use backticks ` ` to enclose tokens; for example:
directive `{"foo": "bar"}`
Inside quoted tokens, all other characters are treated literally, including spaces, tabs, and newlines. Multi-line tokens are thus possible:
directive "first line
second line"
Addresses
An address always appears at the top of the site block, and is usually the first thing in the Caddyfile.
These are examples of valid addresses:
localhostexample.com:443http://example.comlocalhost:8080127.0.0.1[::1]:2015*.example.comhttp://
From the address, Caddy can potentially infer the scheme, host and port of your site. If the address is without a port, the Caddyfile will choose the port matching the scheme if specified, or the default port of 443 will be assumed.
If you specify a hostname, only requests with a matching Host header will be honored. In other words, if the site address is localhost, then Caddy will not match requests to 127.0.0.1.
Wildcards (*) may be used, but only to represent precisely one label of the hostname. For example, *.example.com matches foo.example.com but not foo.bar.example.com, and * matches localhost but not example.com. To catch all hosts, omit the host portion of the address.
If multiple sites share the same definition, you can list all of them together; notice how the commas indicate the continuation of addresses:
localhost:8080, example.com, www.example.com
or
localhost:8080,
example.com,
www.example.com
An address must be unique; you cannot specify the same address more than once.
By default, sites bind on all network interfaces. If you wish to override this, use the bind directive or the default_bind global option to do so.
Matchers
HTTP handler directives apply to all requests by default (unless otherwise documented).
Request matchers can be used to classify requests by a given criteria. This concept originates in the underlying JSON structure, and it's important to know how to use them in the Caddyfile. With matchers, you can specify exactly which requests a certain directive applies to.
For directives that support matchers, the first argument after the directive is the matcher token. Here are some examples:
root * /var/www # matcher token: *
root /index.html /var/www # matcher token: /index.html
root @post /var/www # matcher token: @post
Matcher tokens can be omitted entirely to match all requests; for example, * does not need to be given if the next argument does not look like a path matcher.
Read the page about request matchers to learn more.
Placeholders
You can use any Caddy placeholders in the Caddyfile, but for convenience you can also use some equivalent shorthand ones:
| Shorthand | Replaces |
|---|---|
{cookie.*} |
{http.request.cookie.*} |
{dir} |
{http.request.uri.path.dir} |
{err.*} |
{http.error.*} |
{file_match.*} |
{http.matchers.file.*} |
{file.base} |
{http.request.uri.path.file.base} |
{file.ext} |
{http.request.uri.path.file.ext} |
{file} |
{http.request.uri.path.file} |
{header.*} |
{http.request.header.*} |
{host} |
{http.request.host} |
{hostport} |
{http.request.hostport} |
{labels.*} |
{http.request.host.labels.*} |
{method} |
{http.request.method} |
{path.*} |
{http.request.uri.path.*} |
{path} |
{http.request.uri.path} |
{port} |
{http.request.port} |
{query.*} |
{http.request.uri.query.*} |
{query} |
{http.request.uri.query} |
{re.*.*} |
{http.regexp.*.*} |
{remote_host} |
{http.request.remote.host} |
{remote_port} |
{http.request.remote.port} |
{remote} |
{http.request.remote} |
{rp.*} |
{http.reverse_proxy.*} |
{scheme} |
{http.request.scheme} |
{tls_cipher} |
{http.request.tls.cipher_suite} |
{tls_client_certificate_der_base64} |
{http.request.tls.client.certificate_der_base64} |
{tls_client_certificate_pem} |
{http.request.tls.client.certificate_pem} |
{tls_client_fingerprint} |
{http.request.tls.client.fingerprint} |
{tls_client_issuer} |
{http.request.tls.client.issuer} |
{tls_client_serial} |
{http.request.tls.client.serial} |
{tls_client_subject} |
{http.request.tls.client.subject} |
{tls_version} |
{http.request.tls.version} |
{upstream_hostport} |
{http.reverse_proxy.upstream.hostport} |
{uri} |
{http.request.uri} |
{vars.*} |
{http.vars.*} |
Snippets
You can define special blocks called snippets by giving them a name surrounded in parentheses:
(redirect) {
@http {
protocol http
}
redir @http https://{host}{uri}
}
And then you can reuse this anywhere you need:
import redirect
The import directive can also be used to include other files in its place. As a special case, it can appear almost anywhere within the Caddyfile.
You can pass arguments to imported configuration and use them like so:
(snippet) {
respond "Yahaha! You found {args.0}!"
}
a.example.com {
import snippet "Example A"
}
b.example.com {
import snippet "Example B"
}
Comments
Comments start with # and proceed until the end of the line:
# Comments can start a line
directive # or go at the end
The hash character # for a comment cannot appear in the middle of a token (i.e. it must be preceded by a space or appear at the beginning of a line). This allows the use of hashes within URIs or other values without requiring quoting.
Environment variables
If your configuration relies on environment variables, you can use them in the Caddyfile:
{$SITE_ADDRESS}
Environment variables in this form are substituted before Caddyfile parsing begins, so they can expand to empty values, partial tokens, complete tokens, or even multiple tokens and lines.
A default value can be specified for when the environment variable is not found, by using : as the delimiter between the variable name and the default value:
{$DOMAIN:localhost}
If you want to defer the substitution of an environment variable until runtime, you can use the standard {env.*} placeholders. Note that not all config parameters support these placeholders though, since module developers need to add a line of code to perform the replacement. If it doesn't seem to work, please file an issue to request support for it.
Global options
A Caddyfile may optionally start with a special block that has no keys, called a global options block:
{
...
}
If present, it must be the very first block in the config.
It is used to set options that apply globally, or not to any one site in particular. Inside, only global options can be set; you cannot use regular site directives in them.
Learn more about the global options block.