Docker Image wrapping Certbot client to automate the tasks of obtaining Let's Encrypt certificates.
Until May 2016, Certbot was named simply letsencrypt or letsencrypt-auto, depending on install method. Instructions on the Internet, and some pieces of the software, may still refer to this older name.
Perfectly working with this reverse proxy: blacklabelops/nginx
Features:
- Initial setup of Let's Encrypt certificates
- Automatic renewal of Let's Encrypt certificates each month
- Manual creation of new certificates.
- Manual renewal of certificates.
Will not work inside your local environment. In order to generate valid certificates you will have to run this container on your internet host. Certbot does a bidirectional handshake with letsencrypt.org, this means that the container must be reachable under the respective domain name (e.g. mysubdomain.example.com).
In short, you can create and renew Let's Encrypt SSL certificates!
$ docker run --rm \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=www.example.com" \
blacklabelops/letsencrypt install
Will generate certificates inside docker volume! If you want to add new certificates then use 'renew' instead of 'install'. Note: This example works in debug mode!
You can create and renew Let's Encrypt SSL certificates!
Generate the certificates. This is a one time operation!
Example:
$ docker run --rm \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=www.example.com" \
blacklabelops/letsencrypt install
Will generate the certificates inside Docker volume. If you want to add new certificates then use 'renew' instead of 'install'.
Now setup the container for monthly renewal!
$ docker run --rm \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_DOMAIN1=www.example.com" \
blacklabelops/letsencrypt
Will renew the specified certificates on 15th at 1:15AM of each month.
You can specify multiple domains which will be handled by the image. Each domain must be followed by a number:
Note: Multiple domains will result in one certificate with the specified domains! Let's Encrypt currently takes the certificate specified with LETSENCRYPT_DOMAIN1 as the certificate name for all sub-certificates!
Example:
- Domain1: subdomain1.example.com
- Domain2: www.quitschie.com
- Domain3: mydomain.squeeze.de
Will result in:
$ docker run -d \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
-e "LETSENCRYPT_DOMAIN2=www.quitschie.com" \
-e "LETSENCRYPT_DOMAIN3=mydomain.squeeze.de" \
blacklabelops/letsencrypt
Will renew the certificate inside its volume /etc/letsencrypt/live/subdomain1.example.com
Let's Encrypt uses either HTTP port 80 or HTTPS port 443 for authenticating the domains.
Choose according to the port which is free in your environment and disable the other with the environment variables HTTP_ENABLED and HTTPS_ENABLED. Both are true by default.
Example using HTTP only:
$ docker run -d \
-p 80:80 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_HTTPS_ENABLED=false" \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt
Will renew the certificates inside its volume /etc/letsencrypt
Example using HTTPS only:
$ docker run -d \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_HTTP_ENABLED=false" \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt
Will renew the certificates inside its volume /etc/letsencrypt
Multiple installations will result in multiple accounts inside /etc/letsencrypt/. Multiple installations need an account ID in order to make the container work!
The account ID's can be found inside the folder: /etc/letsencrypt/accounts/acme-v01.api.letsencrypt.org/directory
Now specify the account ID with the environment variable LETSENCRYPT_ACCOUNT_ID.
Example:
$ docker run -d \
-p 80:80 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_HTTPS_ENABLED=false" \
-e "LETSENCRYPT_ACCOUNT_ID=YOUR_ACCOUNT_ID_HERE" \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt
Will renew the certificates inside its volume /etc/letsencrypt for the specific account.
You can invoke all functionality manually. Supported commands are:
- install: Automatic initial install. If you use this multiple times then Certbot will create multiple accounts.
- newcert: Simply generate a new certificate.
- renewal: Automatically renew certificate.
Example install:
$ docker run \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt install
Example newcert:
$ docker run -it \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt newcert
Example renewal:
$ docker run \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_DOMAIN1=subdomain1.example.com" \
blacklabelops/letsencrypt renewal
You can pass additional parameters to any command!
Example adding Certbot --expand parameter:
$ docker run --rm \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_data:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=www.example.com" \
blacklabelops/letsencrypt install --expand
Example adding Certbot --expand parameter to periodic task:
$ docker run --rm \
-p 80:80 \
-p 443:443 \
--name letsencrypt \
-v letsencrypt_data:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=www.example.com" \
blacklabelops/letsencrypt jobberd --expand
Note: This will not work inside on your local comp. You will have to do this inside your target environment.
Steps:
- Create Docker volume for certificates
- Create certificates.
- Start Nginx with certificates.
- Start Container in renewal mode
- Start Cron Container for reloading Nginx config
First create a volume for your certificates:
$ docker volume create letsencrypt_certificates
Creates volume on hosts hard disk.
Then start the letsencrypt container once and create the certificates.
$ docker run --rm \
-p 80:80 \
-p 443:443 \
-v letsencrypt_certificates:/etc/letsencrypt \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=example.com" \
blacklabelops/letsencrypt install
This container will handshake with letsencrypt.org and an account and the certificate when successful.
Then create additional volume for ACME handshakes:
$ docker volume create letsencrypt_challenges
Now you can use the certificate for your reverse proxy! The additional volume will be used for renewal.
$ docker run -d \
-p 443:443 \
-p 80:80 \
-v letsencrypt_certificates:/etc/letsencrypt \
-v letsencrypt_challenges:/var/www/letsencrypt \
-e "NGINX_REDIRECT_PORT80=true" \
-e "SERVER1REVERSE_PROXY_LOCATION1=/" \
-e "SERVER1REVERSE_PROXY_PASS1=http://yourserver" \
-e "SERVER1HTTPS_ENABLED=true" \
-e "SERVER1HTTP_ENABLED=true" \
-e "SERVER1LETSENCRYPT_CERTIFICATES=true" \
-e "SERVER1CERTIFICATE_FILE=/etc/letsencrypt/live/example.com/fullchain.pem" \
-e "SERVER1CERTIFICATE_KEY=/etc/letsencrypt/live/example.com/privkey.pem" \
-e "SERVER1CERTIFICATE_TRUSTED=/etc/letsencrypt/live/example.com/fullchain.pem" \
--name nginx \
blacklabelops/nginx
LETSENCRYPT_CERTIFICATES switches on special configuration for Let's Encrypt certificates. E.g. in order to accept certificate challenges
Now start letsencrypt in renewal mode, this will renew certificates each month!
$ docker run -d \
-v letsencrypt_certificates:/etc/letsencrypt \
-v letsencrypt_challenges:/var/www/letsencrypt \
-e "LETSENCRYPT_WEBROOT_MODE=true" \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=example.com" \
--name letsencrypt \
blacklabelops/letsencrypt
This container will handshake with letsencrypt.org each month on the 15th and renewal the certificate when successful.
Finally start a cron container that will reload the Nginx configuration after the certificates have been renewed!
$ docker run -d \
-v /var/run/docker.sock:/var/run/docker.sock \
-e "JOB_NAME1=ReloadNginx" \
-e "JOB_COMMAND1=docker exec nginx nginx -s reload" \
-e "JOB_TIME1=0 0 2 15 * *" \
-e "JOB_ON_ERROR1=Continue" \
blacklabelops/jobber:docker
Reloads Nginx configuration each month on the 15th over Docker without restarting Nginx! In order to achieve high availability!
Certbot creates the certificates with root permissions per default. If you doesn't run Nginx with the root user, a deploy hook that applies appropriate file permissions need to be used. Otherwise, the Nginx container won't start.
$ docker run -d \
-v letsencrypt_certificates:/etc/letsencrypt \
-v letsencrypt_challenges:/var/www/letsencrypt \
-e "LETSENCRYPT_WEBROOT_MODE=true" \
-e "LETSENCRYPT_EMAIL=dummy@example.com" \
-e "LETSENCRYPT_DOMAIN1=example.com" \
-e "LETSENCRYPT_CERTIFICATES_UID=1000" \
-e "LETSENCRYPT_CERTIFICATES_GID=1000" \
--name letsencrypt \
blacklabelops/letsencrypt
Changes ownership of all content in /etc/letsencrypt from root.root to 1000.1000 and file permissions of all private keys to user read only.