caddy
A Docker image for Caddy. This image includes git, cors, realip, expires, cache and cloudflare plugins.
Plugins can be configured via the plugins
build arg.
Check abiosoft/caddy:builder for generating cross-platform Caddy binaries.
License
This image is built from source code. As such, it is subject to the project's Apache 2.0 license, but it neither contains nor is subject to the EULA for Caddy's official binary distributions.
Let's Encrypt Subscriber Agreement
Caddy may prompt to agree to Let's Encrypt Subscriber Agreement. This is configurable with ACME_AGREE
environment variable. Set it to true to agree. ACME_AGREE=true
.
Telemetry Stats
Starting from v0.11.0
, Telemetry stats are submitted to Caddy by default. To use Caddy without telemetry, use the :no-stats
or :<version>-no-stats
tags. e.g. :0.11.0-no-stats
, :0.11.0-php-no-stats
.
Getting Started
$ docker run -d -p 2015:2015 abiosoft/caddy
Point your browser to http://127.0.0.1:2015
.
Be aware! If you don't bind mount the location certificates are saved to, you may hit Let's Encrypt rate limits rending further certificate generation or renewal disallowed (for a fixed period)! See "Saving Certificates" below!
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 \
abiosoft/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 \
abiosoft/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!
PHP
:[<version>-]php
variant of this image bundles PHP-FPM alongside essential php extensions and composer. e.g. :php
, :0.10.14-php
$ docker run -d -p 2015:2015 abiosoft/caddy:php
Point your browser to http://127.0.0.1:2015
and you will see a php info page.
Local php source
Replace /path/to/php/src
with your php sources directory.
$ docker run -d -v /path/to/php/src:/srv -p 2015:2015 abiosoft/caddy:php
Point your browser to http://127.0.0.1:2015
.
Note
Your Caddyfile
must include the line on startup php-fpm7
. For Caddy to be PID 1 in the container, php-fpm7 could not be started.
Using git sources
Caddy can serve sites from git repository using git plugin.
Create Caddyfile
Replace github.com/abiosoft/webtest
with your repository.
$ printf "0.0.0.0\nroot src\ngit github.com/abiosoft/webtest" > Caddyfile
Run the image
$ docker run -d -v $(pwd)/Caddyfile:/etc/Caddyfile -p 2015:2015 abiosoft/caddy
Point your browser to http://127.0.0.1:2015
.
Custom plugins
You can build a docker image with custom plugins by specifying plugins
build arg as shown in the example below.
docker build --build-arg \
plugins=git,linode \
github.com/abiosoft/caddy-docker.git
Usage
Default Caddyfile
The image contains a default Caddyfile.
0.0.0.0
browse
fastcgi / 127.0.0.1:9000 php # php variant only
on startup php-fpm7 # php variant only
The last 2 lines are only present in the php variant.
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 \
abiosoft/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 \
abiosoft/caddy