|
|
@@ -0,0 +1,182 @@
|
|
|
+<!--
|
|
|
+
|
|
|
+********************************************************************************
|
|
|
+
|
|
|
+WARNING:
|
|
|
+
|
|
|
+ DO NOT EDIT "caddy/README.md"
|
|
|
+
|
|
|
+ IT IS AUTO-GENERATED
|
|
|
+
|
|
|
+ (from the other files in "caddy/" combined with a set of templates)
|
|
|
+
|
|
|
+********************************************************************************
|
|
|
+
|
|
|
+-->
|
|
|
+
|
|
|
+# Supported tags and respective `Dockerfile` links
|
|
|
+
|
|
|
+- [`2.0.0-rc.3`, `2.0.0-rc.3-alpine`, `alpine`, `latest`](https://github.com/caddyserver/caddy-docker/blob/82359bcbcd3d43b8703605afc60370b6c5f87d1f/alpine/Dockerfile)
|
|
|
+- [`2.0.0-rc.3-builder`, `builder`](https://github.com/caddyserver/caddy-docker/blob/82359bcbcd3d43b8703605afc60370b6c5f87d1f/builder/Dockerfile)
|
|
|
+
|
|
|
+# Quick reference
|
|
|
+
|
|
|
+- **Where to get help**:
|
|
|
+ [the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](http://dockr.ly/slack), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
|
|
|
+
|
|
|
+- **Where to file issues**:
|
|
|
+ [https://github.com/caddyserver/caddy-docker/issues](https://github.com/caddyserver/caddy-docker/issues)
|
|
|
+
|
|
|
+- **Maintained by**:
|
|
|
+ [the Caddy Docker Maintainers](https://github.com/caddyserver/caddy-docker)
|
|
|
+
|
|
|
+- **Supported architectures**: ([more info](https://github.com/docker-library/official-images#architectures-other-than-amd64))
|
|
|
+ [`amd64`](https://hub.docker.com/r/amd64/caddy/)
|
|
|
+
|
|
|
+- **Published image artifact details**:
|
|
|
+ [repo-info repo's `repos/caddy/` directory](https://github.com/docker-library/repo-info/blob/master/repos/caddy) ([history](https://github.com/docker-library/repo-info/commits/master/repos/caddy))
|
|
|
+ (image metadata, transfer size, etc)
|
|
|
+
|
|
|
+- **Image updates**:
|
|
|
+ [official-images PRs with label `library/caddy`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fcaddy)
|
|
|
+ [official-images repo's `library/caddy` file](https://github.com/docker-library/official-images/blob/master/library/caddy) ([history](https://github.com/docker-library/official-images/commits/master/library/caddy))
|
|
|
+
|
|
|
+- **Source of this description**:
|
|
|
+ [docs repo's `caddy/` directory](https://github.com/docker-library/docs/tree/master/caddy) ([history](https://github.com/docker-library/docs/commits/master/caddy))
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+# What is Caddy?
|
|
|
+
|
|
|
+[Caddy 2](https://caddyserver.com/) is a powerful, enterprise-ready, open source web server with automatic HTTPS written in Go.
|
|
|
+
|
|
|
+## How to use this image
|
|
|
+
|
|
|
+#### ⚠️ A note about persisted data
|
|
|
+
|
|
|
+Caddy requires write access to two locations: a [data directory](https://caddyserver.com/docs/conventions#data-directory), and a [configuration directory](https://caddyserver.com/docs/conventions#configuration-directory). While it's not necessary to persist the files stored in the configuration directory, it can be convenient. However, it's very important to persist the data directory.
|
|
|
+
|
|
|
+From the docs:
|
|
|
+
|
|
|
+> The data directory must not be treated as a cache. Its contents are not ephemeral or merely for the sake of performance. Caddy stores TLS certificates, private keys, OCSP staples, and other necessary information to the data directory. It should not be purged without an understanding of the implications.
|
|
|
+
|
|
|
+This image provides for two mount-points for volumes: `/data` and `/config`.
|
|
|
+
|
|
|
+In the examples below, a [named volume](https://docs.docker.com/storage/volumes/) `caddy_data` is mounted to `/data`, so that data will be persisted.
|
|
|
+
|
|
|
+Note that named volumes are persisted across container restarts and terminations, so if you move to a new image version, the same data and config directories can be re-used.
|
|
|
+
|
|
|
+### Basic Usage
|
|
|
+
|
|
|
+The default config file simply serves files from `/usr/share/caddy`, so if you want to serve `index.html` from the current working directory:
|
|
|
+
|
|
|
+```console
|
|
|
+$ echo "hello world" > index.html
|
|
|
+$ docker run -d -p 80:80 \
|
|
|
+ -v $PWD/index.html:/usr/share/caddy/index.html \
|
|
|
+ -v caddy_data:/data \
|
|
|
+ caddy
|
|
|
+...
|
|
|
+$ curl http://localhost/
|
|
|
+hello world
|
|
|
+```
|
|
|
+
|
|
|
+To override the default [`Caddyfile`](https://github.com/caddyserver/dist/blob/master/config/Caddyfile), you can mount a new one at `/etc/caddy/Caddyfile`:
|
|
|
+
|
|
|
+```console
|
|
|
+$ docker run -d -p 80:80 \
|
|
|
+ -v $PWD/Caddyfile:/etc/caddy/Caddyfile \
|
|
|
+ -v caddy_data:/data \
|
|
|
+ caddy
|
|
|
+```
|
|
|
+
|
|
|
+### Automatic TLS with the Caddy image
|
|
|
+
|
|
|
+The default `Caddyfile` only listens to port `80`, and does not set up automatic TLS. However, if you have a domain name for your site, and its A/AAAA DNS records are properly pointed to this machine's public IP, then you can use this command to simply serve a site over HTTPS:
|
|
|
+
|
|
|
+```console
|
|
|
+$ docker run -d -p 80:80 -p 443:443 \
|
|
|
+ -v /site:/usr/share/caddy \
|
|
|
+ -v caddy_data:/data \
|
|
|
+ -v caddy_config:/config \
|
|
|
+ caddy caddy file-server --domain example.com
|
|
|
+```
|
|
|
+
|
|
|
+The key here is that Caddy is able to listen to ports `80` and `443`, both required for the ACME HTTP challenge.
|
|
|
+
|
|
|
+See [Caddy's docs](https://caddyserver.com/docs/automatic-https) for more information on automatic HTTPS support!
|
|
|
+
|
|
|
+### Building your own Caddy-based image
|
|
|
+
|
|
|
+Most users deploying production sites will not want to rely on mounting files into a container, but will instead base their own images on `caddy`:
|
|
|
+
|
|
|
+```Dockerfile
|
|
|
+# note: never use the :latest tag in a production site
|
|
|
+FROM caddy:2.0.0
|
|
|
+
|
|
|
+COPY Caddyfile /etc/caddy/Caddyfile
|
|
|
+COPY site /site
|
|
|
+```
|
|
|
+
|
|
|
+#### Adding custom Caddy modules
|
|
|
+
|
|
|
+Caddy is extendable through the use of "modules". See https://caddyserver.com/docs/extending-caddy for full details.
|
|
|
+
|
|
|
+You can use the `:builder` image as a short-cut to building a new Caddy binary:
|
|
|
+
|
|
|
+```Dockerfile
|
|
|
+FROM caddy:2.0.0-builder AS builder
|
|
|
+
|
|
|
+RUN caddy-builder \
|
|
|
+ github.com/caddyserver/nginx-adapter \
|
|
|
+ github.com/hairyhenderson/[email protected]
|
|
|
+
|
|
|
+FROM caddy:2.0.0
|
|
|
+
|
|
|
+COPY --from=builder /usr/bin/caddy /usr/bin/caddy
|
|
|
+```
|
|
|
+
|
|
|
+Note the second `FROM` instruction - this produces a much smaller image by simply overlaying the newly-built binary on top of the the regular `caddy` image.
|
|
|
+
|
|
|
+The `caddy-builder` script is used to [build a new Caddy entrypoint](https://github.com/caddyserver/caddy/blob/71e81d262bc34545f73f1380bc5d078d83d1570f/cmd/caddy/main.go#L15..L25), with the provided modules. You can specify just a module name, or a name with a version (separated by `@`).
|
|
|
+
|
|
|
+Note that the "standard" Caddy modules ([`github.com/caddyserver/caddy/master/modules/standard`](https://github.com/caddyserver/caddy/tree/master/modules/standard)) are always included.
|
|
|
+
|
|
|
+### Graceful reloads
|
|
|
+
|
|
|
+Caddy does not require a full restart when configuration is changed. Caddy comes with a [`caddy reload`](https://caddyserver.com/docs/command-line#caddy-reload) command which can be used to reload its configuration with zero downtime.
|
|
|
+
|
|
|
+When running Caddy in Docker, the recommended way to trigger a config reload is by executing the `caddy reload` command in the running container.
|
|
|
+
|
|
|
+First, you'll need to determine your container ID or name. Then, pass the container ID to `docker exec`.
|
|
|
+
|
|
|
+```console
|
|
|
+$ caddy_container_id=$(docker ps | grep caddy | awk '{print $1;}')
|
|
|
+$ docker exec $caddy_container_id caddy reload --config /etc/caddy/Caddyfile --adapter caddyfile
|
|
|
+```
|
|
|
+
|
|
|
+# Image Variants
|
|
|
+
|
|
|
+The `caddy` images come in many flavors, each designed for a specific use case.
|
|
|
+
|
|
|
+## `caddy:<version>`
|
|
|
+
|
|
|
+This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
|
|
+
|
|
|
+## `caddy:<version>-alpine`
|
|
|
+
|
|
|
+This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
|
|
+
|
|
|
+This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
|
|
+
|
|
|
+To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
|
|
+
|
|
|
+# License
|
|
|
+
|
|
|
+View [license information](https://github.com/caddyserver/caddy/blob/master/LICENSE) for the software contained in this image.
|
|
|
+
|
|
|
+As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
|
|
|
+
|
|
|
+Some additional license information which was able to be auto-detected might be found in [the `repo-info` repository's `caddy/` directory](https://github.com/docker-library/repo-info/tree/master/repos/caddy).
|
|
|
+
|
|
|
+As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
|
Docker Library Bot