diff --git a/README.md b/README.md index 47818e8..01f1e2c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # Certbot Cron Docker -[![Build Status](https://drone.mrmeeb.stream/api/badges/MrMeeb/certbot-cron-docker/status.svg)](https://drone.mrmeeb.stream/MrMeeb/certbot-cron-docker) +![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/certbot-cron-docker/master?label=latest&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) ![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/certbot-cron-docker/develop?label=develop&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) -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. +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 @@ -34,13 +41,16 @@ services: | 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 @@ -48,22 +58,6 @@ services: | --- | --- | | /config | Stores configs and LetsEncrypt output for mounting in other containers -## Building - -``` -git clone https://git.mrmeeb.stream/certbot-cron-docker - -cd certbot-cron-docker - -docker build -t certbot-cron . - -docker run -d --name certbot-cron \ - -e EMAIL=admin@domain.com \ - -e DOMAINS=domain.com \ - -v /docker/certbot-cron:/config \ - certbot-cron -``` - ## 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. \ No newline at end of file