Docker-compose with let’s encrypt : HTTP Challenge

This guide aim to demonstrate how to create a certificate with the let’s encrypt HTTP 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 HTTP challenge you will need:

  • A publicly accessible host allowing connections on port 80 & 443 with docker & docker-compose installed.
  • A DNS record with the domain you want to expose pointing to this host.

Setup

  • Create a docker-compose.yml on your remote server with the following content:
  1. version: "3.3"
  3. services:
  5.   traefik:
  6.     image: "traefik:v2.6"
  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.httpchallenge=true"
  16.       - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web"
  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.     volumes:
  25.       - "./letsencrypt:/letsencrypt"
  26.       - "/var/run/docker.sock:/var/run/docker.sock:ro"
  28.   whoami:
  29.     image: "traefik/whoami"
  30.     container_name: "simple-service"
  31.     labels:
  32.       - "traefik.enable=true"
  33.       - "traefik.http.routers.whoami.rule=Host(`whoami.example.com`)"
  34.       - "traefik.http.routers.whoami.entrypoints=websecure"
  35.       - "traefik.http.routers.whoami.tls.certresolver=myresolver"
  • 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 basic example:

  • 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 HTTPS let’s encrypt challenge:
  1. command:
  2.   # Enable a http challenge named "myresolver"
  3.   - "--certificatesresolvers.myresolver.acme.httpchallenge=true"
  4.   # Tell it to use our predefined entrypoint named "web"
  5.   - "--certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web"
  6.   # The email to provide to let's encrypt
  7.   - "--certificatesresolvers.myresolver.acme.email=postmaster@example.com"
  • 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.   # Uses the Host rule to define which certificate to issue
  3.   - "traefik.http.routers.whoami.tls.certresolver=myresolver"