joseluisq/docker-lets-encrypt
A Let's Encrypt Docker image using Lego CLI client with convenient environment variables support.
5.7K
joseluisq/docker-lets-encrypt repository overview
Docker Let's Encrypt
A multi-arch Let's Encrypt Docker image using Lego CLI client with convenient environment variables support on top of the latest Debian 12-slim (Bookworm).
See the GitHub repository.
Usage
Run the Docker image
# Run Lego CI directly with a particular argument
docker run --rm joseluisq/docker-lets-encrypt -v
# Or run the Docker image in interactive mode
docker run -it --rm joseluisq/docker-lets-encrypt bash
Or extend it
FROM joseluisq/docker-lets-encrypt
# your stuff...
Example
Below is an example of obtaining a wildcard certificate using the Cloudflare provider.
In this case, make sure to create first a Cloudflare API User Token for your specific domain with the DNS:Edit permission.
docker run -it --rm \
-e ENV_LEGO_ENABLE=true \
-e ENV_LEGO_ACCEPT_TOS=true \
-e [email protected] \
-e ENV_LEGO_DOMAINS="*.domain.com" \
-e ENV_LEGO_DNS=cloudflare \
-e [email protected] \
-e CLOUDFLARE_DNS_API_TOKEN= \
-w /root \
-v $PWD:/root/.lego \
joseluisq/docker-lets-encrypt
# 2024/01/01 00:00:30 [INFO] [*.domain.com] acme: Obtaining bundled SAN certificate
# 2024/01/01 00:00:31 [INFO] [*.domain.com] AuthURL: https://acme-v02.api.letsencrypt.org/acme/authz-v3/000000000000
# 2024/01/01 00:00:31 [INFO] [*.domain.com] acme: use dns-01 solver
# 2024/01/01 00:00:31 [INFO] [*.domain.com] acme: Preparing to solve DNS-01
# 2024/01/01 00:00:31 [INFO] Found CNAME entry for "_acme-challenge.domain.com.": "dns.domain.com."
# 2024/01/01 00:00:32 [INFO] cloudflare: new record for domain.com, ID 1234567a8e000d0ab0ced00fgjk123e
# 2024/01/01 00:00:32 [INFO] [*.domain.com] acme: Trying to solve DNS-01
# 2024/01/01 00:00:32 [INFO] Found CNAME entry for "_acme-challenge.domain.com.": "dns.domain.com."
# 2024/01/01 00:00:32 [INFO] [*.domain.com] acme: Checking DNS record propagation. [nameservers=127.0.0.2:00]
# 2024/01/01 00:00:34 [INFO] Wait for propagation [timeout: 2m0s, interval: 2s]
# 2024/01/01 00:00:40 [INFO] [*.domain.com] The server validated our request
# 2024/01/01 00:00:40 [INFO] [*.domain.com] acme: Cleaning DNS-01 challenge
# 2024/01/01 00:00:40 [INFO] Found CNAME entry for "_acme-challenge.domain.com.": "dns.domain.com."
# 2024/01/01 00:00:41 [INFO] [*.domain.com] acme: Validations succeeded; requesting certificates
# 2024/01/01 00:00:42 [INFO] [*.domain.com] Server responded with a certificate.
Notes:
ENV_LEGO_ACCEPT_TOS=trueis used to accept the Let's Encrypt terms of service.- The container
.legodirectory will contain the certificates and keys, make sure to bind it to a specific host directory. See https://go-acme.github.io/lego/usage/cli/general-instructions/ - See the Cloudflare provider options for more details https://go-acme.github.io/lego/dns/cloudflare/
Environment variables
The image provides environment variables support for several Lego CLI arguments.
Below are the environment variables supported and their default values.
Activation
To activate the environment variables support, set ENV_LEGO_ENABLE=true.
ENV_LEGO_ENABLE=false
General options
ENV_LEGO_EMAILENV_LEGO_DOMAINSENV_LEGO_SERVERENV_LEGO_CSRENV_LEGO_ACCEPT_TOS=false
Challenge types
ENV_LEGO_HTTP=falseENV_LEGO_DNSSee Lego DNS providers supported https://go-acme.github.io/lego/dns/#dns-providers
Obtain a new certificate
ENV_LEGO_RUN_HOOK
By default, the Lego CLI run subcommand will be executed, which will obtain a new certificate.
Renew existing certificate
To renew a certificate, use the following environment variables instead.
ENV_LEGO_RENEW=falseENV_LEGO_RENEW_DAYSENV_LEGO_RENEW_HOOK
Additional arguments
ENV_LEGO_ARGS
Print all available Lego CLI options.
# global options
docker run --rm joseluisq/docker-lets-encrypt -h
# or specific subcommand options
docker run --rm joseluisq/docker-lets-encrypt lego run -h
For more details check out the Lego CLI available options.
Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
Feel free to send some Pull request or file an issue.
License
This work is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).
© 2024-present Jose Quintana
Tag summary
Content type
Image
Digest
sha256:bab75d2e0…
Size
51.4 MB
Last updated
about 2 years ago
docker pull joseluisq/docker-lets-encrypt