This is my one-stop shop for configuring and running Caddy with Docker including setting up plugins and providing a reference on how to do common configurations.
Get started by cloning the repository and pulling up the service:
git clone https://github.com/insertish/caddy
cd caddy
cp Caddyfile.example Caddyfile
docker-compose up -d
Caddy will bind to https://localhost:80 and you can now configure it as usual.
There are several scripts available to make your life easier:
reload.sh
: apply an updated Caddyfile to the running Caddy servervalidate.sh
: ensure the provided configuration is validfmt.sh
: format the provided Caddyfile
To start using plugins, copy the example Dockerfile:
cp Dockerfile.example Dockerfile
And configure docker-compose.override.yml
to build it:
version: "3"
services:
caddy:
build: .
Below are a bunch of useful snippets for common web server configurations which I use really frequently.
You may also want to refer to the full directives documentation from Caddy.
Setting up a reverse proxy takes up a single line:
a.test {
reverse_proxy 127.0.0.1:5000
}
You can also do stuff like send headers up to the upstream service along with other configuration, refer to reverse_proxy.
The following is sufficient to properly handle upgrading WebSockets:
@upgrade {
path /
header Connection *Upgrade*
header Upgrade websocket
}
reverse_proxy @upgrade 127.0.0.1:10540
Refer to tls on how to configure specific DNS providers.
:80 {
respond "Hello, World!"
}
*.test {
tls {
dns <provider> <token>
}
@a host a.test
handle @a {
respond "Subdomain a.test"
}
@b host b.test
handle @b {
respond "Subdomain b.test"
}
handle {
respond "Default handler for *.test"
}
}
Below is a sample logger configuration which writes to the data directory.
{
log {
output file /data/access.log {
roll_size 1GiB
}
format json
level debug
}
}
Now you can run tail -f data/access.log
to read from it live.
A common pattern is to handle a route and strip the path prefix, you can combine multiple lines into one as such:
handle_path /prefix/* {
[...]
}
When the request is being handled, /prefix
is ignored, so you can now pass this through to your upstream service for example. See documentation for handle_path and uri for strip_prefix.