Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iarekylew00t/docker-caddy-cloudflare
🐳 The Caddy Docker image built with the Cloudflare DNS module
https://github.com/iarekylew00t/docker-caddy-cloudflare
acme caddy cloudflare dns dns-01 docker docker-caddy
Last synced: 1 day ago
JSON representation
🐳 The Caddy Docker image built with the Cloudflare DNS module
- Host: GitHub
- URL: https://github.com/iarekylew00t/docker-caddy-cloudflare
- Owner: IAreKyleW00t
- License: apache-2.0
- Created: 2023-01-13T03:17:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-25T05:34:06.000Z (9 days ago)
- Last Synced: 2024-12-25T06:27:37.377Z (9 days ago)
- Topics: acme, caddy, cloudflare, dns, dns-01, docker, docker-caddy
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/iarekylew00t/caddy-cloudflare
- Size: 209 KB
- Stars: 73
- Watchers: 3
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🐳 caddy-cloudflare
[](https://hub.docker.com/r/iarekylew00t/caddy-cloudflare)
[](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tags)
[](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/actions/workflows/docker.yml)
[](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/blob/main/LICENSE)
[](.github/dependabot.yml)
The [Caddy](https://hub.docker.com/_/caddy) Docker image with the added
[caddy-dns/cloudflare](https://github.com/caddy-dns/cloudflare) module for
DNS-01 ACME validation support.
Built for the same platforms as the upstream Caddy project (except Windows, sorry)!
> [!NOTE]
> This image does not change anything with original Caddy Docker image except
> replace the `caddy` binary.
```sh
# Docker Hub
docker pull iarekylew00t/caddy-cloudflare:latest
# GHCR
docker pull ghcr.io/iarekylew00t/caddy-cloudflare:latest
```
## Tags
The following tags are the latest available for the
`iarekylew00t/caddy-cloudflare` image.
- [`latest`](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tree/v2.8.4)
- [`2.8.4`](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tree/v2.8.4)
- [`2.8`](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tree/v2.8)
- [`2`](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tree/v2)
Check the GitHub
[Tags](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/tags)
for a list of all versions!
## Usage
### Docker
Since this is built off the official Docker image all of the same Volumes,
Environment variables, etc. can be used with this container. Please refer to the
official [Caddy](https://hub.docker.com/_/caddy) Docker image and
[docs](https://caddyserver.com/docs/) for more information on using Caddy.
Simply create the container as usual and include your `CF_API_TOKEN` (email no
longer required for API Tokens). We can utilize Caddy's support for
[Environment varaiables](https://caddyserver.com/docs/caddyfile/concepts#environment-variables)
to pass these values into our `Caddyfile`.
> [!IMPORTANT]
> Be sure to create your `Caddyfile` beforehand to avoid Docker startup errors.
```sh
docker run --rm -it \
--name caddy \
-p 80:80 \
-p 443:443 \
-v caddy_data:/data \
-v caddy_config:/config \
-v $PWD/Caddyfile:/etc/caddy/Caddyfile \
-e CF_API_TOKEN=UhKLc...JD9jk \
iarekylew00t/caddy-cloudflare:latest
```
If you prefer `docker-compose` you can use the provided
[`docker-compose.yml`](docker-compose.yml) after updating it with your
`CF_API_TOKEN`.
```sh
docker compose up
```
### Caddy
Set the global
[acme_dns](https://caddyserver.com/docs/caddyfile/options#acme-dns) directive
in your `Caddyfile`
```Caddyfile
{
acme_dns cloudflare {env.CF_API_TOKEN}
}
```
or via JSON
```json
{
"module": "acme",
"challenges": {
"dns": {
"provider": {
"name": "cloudflare",
"api_token": "{env.CF_API_TOKEN}"
}
}
}
}
```
See the [caddy-dns/cloudflare](https://github.com/caddy-dns/cloudflare) module
and [`tls`](https://caddyserver.com/docs/caddyfile/directives/tls#tls) directive
for advanced usage.
### Creating a Cloudflare API Token
You can generate a Cloudflare API token via the Cloudflare web console using the following steps:
1. Login to your [Dashboard](https://dash.cloudflare.com/)
2. Go to [Account Profile](https://dash.cloudflare.com/profile) > [API Tokens](https://dash.cloudflare.com/profile/api-tokens)
3. Click "Create token" (Use the "Create Custom Token" option)
4. Grant the following permissions:
- `Zone > Zone > Read`
- `Zone > DNS > Edit`
## Building
You can easily build the Docker image locally by doing
```sh
docker build -t caddy-cloudflare .
```
If you prefer `docker-compose` you can use the provided
[`docker-compose.yml`](docker-compose.yml) for building
```sh
docker compose build
```
## Container signatures
All container images will be automatically signed via
[Cosign](https://docs.sigstore.dev/cosign/overview/) using
[keyless signatures](https://docs.sigstore.dev/cosign/keyless/). You can use the
following command to verify the integrity of these images yourself.
```sh
cosign verify \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-identity-regexp https://github.com/IAreKyleW00t/docker-caddy-cloudflare/.github/workflows/ \
iarekylew00t/caddy-cloudflare:latest
```
## Contributing
Feel free to contribute and make things better by opening an
[Issue](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/issues) or
[Pull Request](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/pulls).
## License
See [LICENSE](https://github.com/IAreKyleW00t/docker-caddy-cloudflare/blob/main/LICENSE).