Docker-compose with let’s encrypt: DNS Challenge

This guide aim to demonstrate how to create a certificate with the let’s encrypt DNS challenge to use https on a simple service exposed with Traefik.
Please also read the basic example for details on how to expose such a service.

Prerequisite

For the DNS challenge, you’ll need:

  • A working provider along with the credentials allowing to create and remove DNS records.

Variables may vary depending on the Provider.

Please note this guide may vary depending on the provider you use. The only things changing are the names of the variables you will need to define in order to configure your provider so it can create DNS records.
Please refer the list of providers given right above and replace all the environment variables with the ones described in this documentation.

Setup

  • Create a docker-compose.yml file with the following content:
  1. version: "3.3"
  3. services:
  5.   traefik:
  6.     image: "traefik:v2.4"
  7.     container_name: "traefik"
  8.     command:
  9.       #- "--log.level=DEBUG"
  10.       - "--api.insecure=true"
  11.       - "--providers.docker=true"
  12.       - "--providers.docker.exposedbydefault=false"
  13.       - "--entrypoints.web.address=:80"
  14.       - "--entrypoints.websecure.address=:443"
  15.       - "--certificatesresolvers.myresolver.acme.dnschallenge=true"
  16.       - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh"
  17.       #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"
  18.       - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com"
  19.       - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
  20.     ports:
  21.       - "80:80"
  22.       - "443:443"
  23.       - "8080:8080"
  24.     environment:
  25.       - "OVH_ENDPOINT=xxx"
  26.       - "OVH_APPLICATION_KEY=xxx"
  27.       - "OVH_APPLICATION_SECRET=xxx"
  28.       - "OVH_CONSUMER_KEY=xxx"
  29.     volumes:
  30.       - "./letsencrypt:/letsencrypt"
  31.       - "/var/run/docker.sock:/var/run/docker.sock:ro"
  33.   whoami:
  34.     image: "traefik/whoami"
  35.     container_name: "simple-service"
  36.     labels:
  37.       - "traefik.enable=true"
  38.       - "traefik.http.routers.whoami.rule=Host(`whoami.example.com`)"
  39.       - "traefik.http.routers.whoami.entrypoints=websecure"
  40.       - "traefik.http.routers.whoami.tls.certresolver=myresolver"

  • Replace the environment variables by your own:

    1. environment:
    2.   - "OVH_ENDPOINT=[YOUR_OWN_VALUE]"
    3.   - "OVH_APPLICATION_KEY=[YOUR_OWN_VALUE]"
    4.   - "OVH_APPLICATION_SECRET=[YOUR_OWN_VALUE]"
    5.   - "OVH_CONSUMER_KEY=[YOUR_OWN_VALUE]"

  • Replace postmaster@example.com by your own email within the certificatesresolvers.myresolver.acme.email command line argument of the traefik service.

  • Replace whoami.example.com by your own domain within the traefik.http.routers.whoami.rule label of the whoami service.

  • Optionally uncomment the following lines if you want to test/debug:

    1. #- "--log.level=DEBUG"
    2. #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"

  • Run docker-compose up -d within the folder where you created the previous file.

  • Wait a bit and visit https://your_own_domain to confirm everything went fine.

Note

If you uncommented the acme.caserver line, you will get an SSL error, but if you display the certificate and see it was emitted by Fake LE Intermediate X1 then it means all is good. (It is the staging environment intermediate certificate used by let’s encrypt). You can now safely comment the acme.caserver line, remove the letsencrypt/acme.json file and restart Traefik to issue a valid certificate.

Explanation

What changed between the initial setup:

  • We configure a second entry point for the https traffic:
  1. command:
  2.   # Traefik will listen to incoming request on the port 443 (https)
  3.   - "--entrypoints.websecure.address=:443"
  4. ports:
  5.   - "443:443"
  • We configure the DNS let’s encrypt challenge:
  1. command:
  2.   # Enable a dns challenge named "myresolver"
  3.   - "--certificatesresolvers.myresolver.acme.dnschallenge=true"
  4.   # Tell which provider to use
  5.   - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh"
  6.   # The email to provide to let's encrypt
  7.   - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com"
  • We provide the required configuration to our provider via environment variables:
  1. environment:
  2.   - "OVH_ENDPOINT=xxx"
  3.   - "OVH_APPLICATION_KEY=xxx"
  4.   - "OVH_APPLICATION_SECRET=xxx"
  5.   - "OVH_CONSUMER_KEY=xxx"

Note

This is the step that may vary depending on the provider you use. Just define the variables required by your provider. (see the prerequisite for a list)

  • We add a volume to store our certificates:
  1. volumes:
  2.   # Create a letsencrypt dir within the folder where the docker-compose file is
  3.   - "./letsencrypt:/letsencrypt"
  5. command:
  6.   # Tell to store the certificate on a path under our volume
  7.   - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
  • We configure the whoami service to tell Traefik to use the certificate resolver named myresolver we just configured:
  1. labels:
  2.     - "traefik.http.routers.whoami.tls.certresolver=myresolver" # Uses the Host rule to define which certificate to issue

Use Secrets

To configure the provider, and avoid having the secrets exposed in plaintext within the docker-compose environment section, you could use docker secrets.
The point is to manage those secret files by another mean, and read them from the docker-compose.yml file making the docker-compose file itself less sensitive.

  • Create a directory named secrets, and create a file for each parameters required to configure you provider containing the value of the parameter:
    for example, the ovh_endpoint.secret file contain ovh-eu
  1. ./secrets
  2. ├── ovh_application_key.secret
  3. ├── ovh_application_secret.secret
  4. ├── ovh_consumer_key.secret
  5. └── ovh_endpoint.secret

Note

You could store those secrets anywhere on the server, just make sure to use the proper path for the file directive for the secrets definition in the docker-compose.yml file.

  • Use this docker-compose.yml file:
  1. version: "3.3"
  3. secrets:
  4.   ovh_endpoint:
  5.     file: "./secrets/ovh_endpoint.secret"
  6.   ovh_application_key:
  7.     file: "./secrets/ovh_application_key.secret"
  8.   ovh_application_secret:
  9.     file: "./secrets/ovh_application_secret.secret"
  10.   ovh_consumer_key:
  11.     file: "./secrets/ovh_consumer_key.secret"
  13. services:
  15.   traefik:
  16.     image: "traefik:v2.4"
  17.     container_name: "traefik"
  18.     command:
  19.       #- "--log.level=DEBUG"
  20.       - "--api.insecure=true"
  21.       - "--providers.docker=true"
  22.       - "--providers.docker.exposedbydefault=false"
  23.       - "--entrypoints.web.address=:80"
  24.       - "--entrypoints.websecure.address=:443"
  25.       - "--certificatesresolvers.myresolver.acme.dnschallenge=true"
  26.       - "--certificatesresolvers.myresolver.acme.dnschallenge.provider=ovh"
  27.       #- "--certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"
  28.       - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com"
  29.       - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
  30.     ports:
  31.       - "80:80"
  32.       - "443:443"
  33.       - "8080:8080"
  34.     secrets:
  35.       - "ovh_endpoint"
  36.       - "ovh_application_key"
  37.       - "ovh_application_secret"
  38.       - "ovh_consumer_key"
  39.     environment:
  40.       - "OVH_ENDPOINT_FILE=/run/secrets/ovh_endpoint"
  41.       - "OVH_APPLICATION_KEY_FILE=/run/secrets/ovh_application_key"
  42.       - "OVH_APPLICATION_SECRET_FILE=/run/secrets/ovh_application_secret"
  43.       - "OVH_CONSUMER_KEY_FILE=/run/secrets/ovh_consumer_key"
  44.     volumes:
  45.       - "./letsencrypt:/letsencrypt"
  46.       - "/var/run/docker.sock:/var/run/docker.sock:ro"
  48.   whoami:
  49.     image: "traefik/whoami"
  50.     container_name: "simple-service"
  51.     labels:
  52.       - "traefik.enable=true"
  53.       - "traefik.http.routers.whoami.rule=Host(`whoami.example.com`)"
  54.       - "traefik.http.routers.whoami.entrypoints=websecure"
  55.       - "traefik.http.routers.whoami.tls.certresolver=myresolver"

Note

Still think about changing postmaster@example.com & whoami.example.com by your own values.

Let’s explain a bit what we just did:

  • The following section allow to read files on the docker host, and expose those file under /run/secrets/[NAME_OF_THE_SECRET] within the container:
  1. secrets:
  2.   # secret name also used to name the file exposed within the container
  3.   ovh_endpoint:
  4.      # path on the host
  5.     file: "./secrets/ovh_endpoint.secret"
  6.   ovh_application_key:
  7.     file: "./secrets/ovh_application_key.secret"
  8.   ovh_application_secret:
  9.     file: "./secrets/ovh_application_secret.secret"
  10.   ovh_consumer_key:
  11.     file: "./secrets/ovh_consumer_key.secret"
  13. services:
  14.   traefik:
  15.     # expose the predefined secret to the container by name
  16.     secrets:
  17.       - "ovh_endpoint"
  18.       - "ovh_application_key"
  19.       - "ovh_application_secret"
  20.       - "ovh_consumer_key"
  • The environment variable within our whoami service are suffixed by _FILE which allow us to point to files containing the value, instead of exposing the value itself.
    The acme client will read the content of those file to get the required configuration values.
  1. environment:
  2.   # expose the path to file provided by docker containing the value we want for OVH_ENDPOINT.
  3.   - "OVH_ENDPOINT_FILE=/run/secrets/ovh_endpoint"
  4.   - "OVH_APPLICATION_KEY_FILE=/run/secrets/ovh_application_key"
  5.   - "OVH_APPLICATION_SECRET_FILE=/run/secrets/ovh_application_secret"
  6.   - "OVH_CONSUMER_KEY_FILE=/run/secrets/ovh_consumer_key"