jimmidyson/caddy repository overview

⁠caddy

A Docker⁠ image for Caddy⁠. This image includes the following plugins:

• git⁠ plugin.
• cors⁠ plugin.
• expires⁠ plugin.
• jwt⁠ plugin.
• minify⁠ plugin.
• prometheus⁠ plugin.
• ratelimit⁠ plugin.

Plugins can be configured via the plugins build arg.

⁠Getting Started

$ docker run -d -p 2015:2015 jimmidyson/caddy

Point your browser to http://127.0.0.1:2015.

⁠Saving Certificates

Save certificates on host machine to prevent regeneration every time container starts. Let's Encrypt has rate limit⁠.

$ docker run -d \
    -v $(pwd)/Caddyfile:/etc/Caddyfile \
    -v $HOME/.caddy:/root/.caddy \
    -p 80:80 -p 443:443 \
    jimmidyson/caddy

Here, /root/.caddy is the location inside the container where caddy will save certificates.

Additionally, you can use an environment variable to define the exact location caddy should save generated certificates:

$ docker run -d \
    -e "CADDYPATH=/etc/caddycerts" \
    -v $HOME/.caddy:/etc/caddycerts \
    -p 80:80 -p 443:443 \
    jimmidyson/caddy

Above, we utilize the CADDYPATH environment variable to define a different location inside the container for certificates to be stored. This is probably the safest option as it ensures any future docker image changes don't interfere with your ability to save certificates!

⁠Using git sources

Caddy can serve sites from git repository using git⁠ plugin.

⁠Create Caddyfile

Replace github.com/jimmidyson/webtest with your repository.

$ printf "0.0.0.0\nroot src\ngit github.com/jimmidyson/webtest" > Caddyfile

⁠Run the image

$ docker run -d -v $(pwd)/Caddyfile:/etc/Caddyfile -p 2015:2015 jimmidyson/caddy

Point your browser to http://127.0.0.1:2015.

⁠Usage

⁠Default Caddyfile

The image contains a default Caddyfile.

0.0.0.0
log stdout
errors stdout
gzip
prometheus

⁠Paths in container

Caddyfile: /etc/Caddyfile

Sites root: /srv

⁠Using local Caddyfile and sites root

Replace /path/to/Caddyfile and /path/to/sites/root accordingly.

$ docker run -d \
    -v /path/to/sites/root:/srv \
    -v path/to/Caddyfile:/etc/Caddyfile \
    -p 2015:2015 \
    jimmidyson/caddy

⁠Let's Encrypt Auto SSL

Note that this does not work on local environments.

Use a valid domain and add email to your Caddyfile to avoid prompt at runtime. Replace mydomain.com with your domain and [email protected] with your email.

mydomain.com
tls [email protected]

⁠Run the image

You can change the the ports if ports 80 and 443 are not available on host. e.g. 81:80, 444:443

$ docker run -d \
    -v $(pwd)/Caddyfile:/etc/Caddyfile \
    -p 80:80 -p 443:443 \
    jimmidyson/caddy