65 lines
2.9 KiB
Markdown
65 lines
2.9 KiB
Markdown
# Certbot Cron Docker
|
|
|
|
 
|
|
|
|
Dockerised Certbot that utilises cron to schedule creating and renewing SSL certificates. Uses Cloudflare for DNS-01 verification. Automatic renewal attempt happens every 6 hours by default.
|
|
|
|
## Tags
|
|
|
|
|Tag |Description|
|
|
|-------|-----------|
|
|
|latest |Latest image built from the main branch. Usually coincides with a tagged release.|
|
|
|develop|Latest image built from the develop branch. Commits are made to the develop branch before being merged to main. Old versions of `develop` are removed after 14 days.|
|
|
|
|
## Running
|
|
|
|
### Docker CLI
|
|
```
|
|
docker run -d --name certbot \
|
|
-e EMAIL=admin@domain.com \
|
|
-e DOMAINS=domain.com \
|
|
-e CLOUDFLARE_TOKEN=123abc
|
|
-v /docker/certbot-cron:/config \
|
|
git.mrmeeb.stream/mrmeeb/certbot-cron:latest
|
|
```
|
|
|
|
### Docker Compose
|
|
```
|
|
version: "3"
|
|
services:
|
|
certbot:
|
|
image: git.mrmeeb.stream/mrmeeb/certbot-cron:latest
|
|
container_name: certbot
|
|
restart: unless-stopped
|
|
volumes:
|
|
- ./certbot:/config
|
|
environment:
|
|
- EMAIL=admin@domain.com
|
|
- DOMAINS=domain.com,*.domain.com
|
|
- CLOUDFLARE_TOKEN=123abc
|
|
```
|
|
|
|
## Environment Variables:
|
|
|
|
| Variable | Default Value | Description |
|
|
| --- | --- | --- |
|
|
|PUID |int |1000 |Sets the UID of the user certbot runs under |
|
|
|PGID |int |1000 |Sets the GID of the user certbot runs under |
|
|
|TZ |[List of valid TZs](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) |UTC |Sets the timezone of the container |
|
|
| EMAIL | None | Email address for renewal information & other communications |
|
|
| DOMAINS | None | Domains to be included in the certificate. Comma separated list, no spaces. Wildcards supported |
|
|
| INTERVAL | 0 */6 * * * | How often certbot attempts to renew the certificate. Cron syntax |
|
|
| STAGING | false (case-sensitive) | Uses the LetsEncrypt staging endpoint for testing - avoids the aggressive rate-limiting of the production endpoint |
|
|
| PROPOGATION_TIME | 10 | The amount of time (seconds) that certbot waits for the TXT records to propogate to Cloudflare before verifying - the more domains in the certificate, the longer you might need |
|
|
| GENERATE_DHPARAM | true (case-sensitive) | Generate Diffie-Hellman keys in /config/letsencrypt/keys |
|
|
| CLOUDFLARE_TOKEN | N/A | Cloudflare token for verification |
|
|
|
|
## Volumes
|
|
|
|
| Docker path | Purpose |
|
|
| --- | --- |
|
|
| /config | Stores configs and LetsEncrypt output for mounting in other containers
|
|
|
|
## Other
|
|
|
|
Thanks to [this guy](https://stackoverflow.com/questions/63447441/docker-stop-for-crond-times-out) for explaining how to make cron actually shutdown when stopping the container. |