Skip to content

abiosoft/caddy-docker

Repository files navigation

caddy

ADockerimage forCaddy.This image includesgit,cors,realip,expires,cacheandcloudflareplugins.

Plugins can be configured via thepluginsbuild arg.

Checkabiosoft/caddy:builderfor generating cross-platform Caddy binaries.

License

This image is built fromsource code.As such, it is subject to the project'sApache 2.0 license,but it neither contains nor is subject tothe EULA for Caddy's official binary distributions.

Let's Encrypt Subscriber Agreement

Caddy may prompt to agree toLet's Encrypt Subscriber Agreement.This is configurable withACME_AGREEenvironment variable. Set it to true to agree.ACME_AGREE=true.

Telemetry Stats

Starting fromv0.11.0,Telemetry statsare submitted to Caddy by default. To use Caddy without telemetry, use the:no-statsor:<version>-no-statstags. 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 tohttp://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 ratelimitsrending 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 hasrate limit.

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

Here,/root/.caddyis the locationinsidethe container where caddy will save certificates.

Additionally, you can use anenvironment variableto 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 theCADDYPATHenvironment 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>-]phpvariant of this image bundles PHP-FPM alongside essential php extensions andcomposer.e.g.:php,:0.10.14-php

$ docker run -d -p 2015:2015 abiosoft/caddy:php

Point your browser tohttp://127.0.0.1:2015and you will see a php info page.

Local php source

Replace/path/to/php/srcwith your php sources directory.

$ docker run -d -v /path/to/php/src:/srv -p 2015:2015 abiosoft/caddy:php

Point your browser tohttp://127.0.0.1:2015.

Note

YourCaddyfilemust include the lineon 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 usinggitplugin.

Create Caddyfile

Replacegithub /abiosoft/webtestwith your repository.

$printf"0.0.0.0\nroot src\ngit github /abiosoft/webtest">Caddyfile
Run the image
$ docker run -d -v$(pwd)/Caddyfile:/etc/Caddyfile -p 2015:2015 abiosoft/caddy

Point your browser tohttp://127.0.0.1:2015.

Custom plugins

You can build a docker image with custom plugins by specifyingpluginsbuild arg as shown in the example below.

docker build --build-arg \
plugins=git,linode \
github /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/Caddyfileand/path/to/sites/rootaccordingly.

$ 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

Notethat this does not work on local environments.

Use a valid domain and add email to your Caddyfile to avoid prompt at runtime. Replacemydomainwith your domain anduser@hostwith your email.

mydomain
tls user@host
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