Let’s Encrypt

Automatic HTTPS

You can configure Traefik to use an ACME provider (like Let’s Encrypt) for automatic certificate generation.

Let’s Encrypt and Rate Limiting

Note that Let’s Encrypt API has rate limiting.

Use Let’s Encrypt staging server with the caServer configuration option when experimenting to avoid hitting this limit too fast.

Certificate Resolvers

Traefik requires you to define “Certificate Resolvers” in the static configuration, which are responsible for retrieving certificates from an ACME server.

Then, each “router” is configured to enable TLS, and is associated to a certificate resolver through the tls.certresolver configuration option.

Certificates are requested for domain names retrieved from the router’s dynamic configuration.

You can read more about this retrieval mechanism in the following section: ACME Domain Definition.

Defining an ACME challenge type is a requirement for a certificate resolver to be functional.

Defining a certificate resolver does not result in all routers automatically using it. Each router that is supposed to use the resolver must reference it.

Configuration Reference

There are many available options for ACME. For a quick glance at what’s possible, browse the configuration reference:

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     # Enable ACME (Let's Encrypt): automatic SSL.
  4.     acme:
  6.       # Email address used for registration.
  7.       #
  8.       # Required
  9.       #
  10.       email: "test@example.com"
  12.       # File or key used for certificates storage.
  13.       #
  14.       # Required
  15.       #
  16.       storage: "acme.json"
  18.       # CA server to use.
  19.       # Uncomment the line to use Let's Encrypt's staging server,
  20.       # leave commented to go to prod.
  21.       #
  22.       # Optional
  23.       # Default: "https://acme-v02.api.letsencrypt.org/directory"
  24.       #
  25.       # caServer: "https://acme-staging-v02.api.letsencrypt.org/directory"
  27.       # The certificates' duration in hours.
  28.       # It defaults to 2160 (90 days) to follow Let's Encrypt certificates' duration.
  29.       #
  30.       # Optional
  31.       # Default: 2160
  32.       #
  33.       # certificatesDuration: 2160
  35.       # Preferred chain to use.
  36.       #
  37.       # If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name.
  38.       # If no match, the default offered chain will be used.
  39.       #
  40.       # Optional
  41.       # Default: ""
  42.       #
  43.       # preferredChain: 'ISRG Root X1'
  45.       # KeyType to use.
  46.       #
  47.       # Optional
  48.       # Default: "RSA4096"
  49.       #
  50.       # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  51.       #
  52.       # keyType: RSA4096
  54.       # Use a TLS-ALPN-01 ACME challenge.
  55.       #
  56.       # Optional (but recommended)
  57.       #
  58.       tlsChallenge:
  60.       # Use a HTTP-01 ACME challenge.
  61.       #
  62.       # Optional
  63.       #
  64.       # httpChallenge:
  66.         # EntryPoint to use for the HTTP-01 challenges.
  67.         #
  68.         # Required
  69.         #
  70.         # entryPoint: web
  72.       # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  73.       # Note: mandatory for wildcard certificate generation.
  74.       #
  75.       # Optional
  76.       #
  77.       # dnsChallenge:
  79.         # DNS provider used.
  80.         #
  81.         # Required
  82.         #
  83.         # provider: digitalocean
  85.         # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  86.         # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  87.         # Useful if internal networks block external DNS queries.
  88.         #
  89.         # Optional
  90.         # Default: 0
  91.         #
  92.         # delayBeforeCheck: 0
  94.         # Use following DNS servers to resolve the FQDN authority.
  95.         #
  96.         # Optional
  97.         # Default: empty
  98.         #
  99.         # resolvers
  100.         # - "1.1.1.1:53"
  101.         # - "8.8.8.8:53"
  103.         # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  104.         #
  105.         # NOT RECOMMENDED:
  106.         # Increase the risk of reaching Let's Encrypt's rate limits.
  107.         #
  108.         # Optional
  109.         # Default: false
  110.         #
  111.         # disablePropagationCheck: true

File (TOML)

  1. # Enable ACME (Let's Encrypt): automatic SSL.
  2. [certificatesResolvers.myresolver.acme]
  4.   # Email address used for registration.
  5.   #
  6.   # Required
  7.   #
  8.   email = "test@example.com"
  10.   # File or key used for certificates storage.
  11.   #
  12.   # Required
  13.   #
  14.   storage = "acme.json"
  16.   # CA server to use.
  17.   # Uncomment the line to use Let's Encrypt's staging server,
  18.   # leave commented to go to prod.
  19.   #
  20.   # Optional
  21.   # Default: "https://acme-v02.api.letsencrypt.org/directory"
  22.   #
  23.   # caServer = "https://acme-staging-v02.api.letsencrypt.org/directory"
  25.   # The certificates' duration in hours.
  26.   # It defaults to 2160 (90 days) to follow Let's Encrypt certificates' duration.
  27.   #
  28.   # Optional
  29.   # Default: 2160
  30.   #
  31.   # certificatesDuration=2160
  33.   # Preferred chain to use.
  34.   #
  35.   # If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name.
  36.   # If no match, the default offered chain will be used.
  37.   #
  38.   # Optional
  39.   # Default: ""
  40.   #
  41.   # preferredChain = "ISRG Root X1"
  43.   # KeyType to use.
  44.   #
  45.   # Optional
  46.   # Default: "RSA4096"
  47.   #
  48.   # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  49.   #
  50.   # keyType = "RSA4096"
  52.   # Use a TLS-ALPN-01 ACME challenge.
  53.   #
  54.   # Optional (but recommended)
  55.   #
  56.   [certificatesResolvers.myresolver.acme.tlsChallenge]
  58.   # Use a HTTP-01 ACME challenge.
  59.   #
  60.   # Optional
  61.   #
  62.   # [certificatesResolvers.myresolver.acme.httpChallenge]
  64.     # EntryPoint to use for the HTTP-01 challenges.
  65.     #
  66.     # Required
  67.     #
  68.     # entryPoint = "web"
  70.   # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  71.   # Note: mandatory for wildcard certificate generation.
  72.   #
  73.   # Optional
  74.   #
  75.   # [certificatesResolvers.myresolver.acme.dnsChallenge]
  77.     # DNS provider used.
  78.     #
  79.     # Required
  80.     #
  81.     # provider = "digitalocean"
  83.     # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  84.     # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  85.     # Useful if internal networks block external DNS queries.
  86.     #
  87.     # Optional
  88.     # Default: 0
  89.     #
  90.     # delayBeforeCheck = 0
  92.     # Use following DNS servers to resolve the FQDN authority.
  93.     #
  94.     # Optional
  95.     # Default: empty
  96.     #
  97.     # resolvers = ["1.1.1.1:53", "8.8.8.8:53"]
  99.     # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  100.     #
  101.     # NOT RECOMMENDED:
  102.     # Increase the risk of reaching Let's Encrypt's rate limits.
  103.     #
  104.     # Optional
  105.     # Default: false
  106.     #
  107.     # disablePropagationCheck = true

CLI

  1. # Enable ACME (Let's Encrypt): automatic SSL.
  3. # Email address used for registration.
  4. #
  5. # Required
  6. #
  7. --certificatesresolvers.myresolver.acme.email=test@example.com
  9. # File or key used for certificates storage.
  10. #
  11. # Required
  12. #
  13. --certificatesresolvers.myresolver.acme.storage=acme.json
  15. # CA server to use.
  16. # Uncomment the line to use Let's Encrypt's staging server,
  17. # leave commented to go to prod.
  18. #
  19. # Optional
  20. # Default: "https://acme-v02.api.letsencrypt.org/directory"
  21. #
  22. --certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory
  24. # The certificates' duration in hours.
  25. # It defaults to 2160 (90 days) to follow Let's Encrypt certificates' duration.
  26. #
  27. # Optional
  28. # Default: 2160
  29. #
  30. --certificatesresolvers.myresolver.acme.certificatesDuration=2160
  32. # Preferred chain to use.
  33. #
  34. # If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name.
  35. # If no match, the default offered chain will be used.
  36. #
  37. # Optional
  38. # Default: ""
  39. #
  40. --certificatesresolvers.myresolver.acme.preferredchain="ISRG Root X1"
  42. # KeyType to use.
  43. #
  44. # Optional
  45. # Default: "RSA4096"
  46. #
  47. # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  48. #
  49. --certificatesresolvers.myresolver.acme.keytype=RSA4096
  51. # Use a TLS-ALPN-01 ACME challenge.
  52. #
  53. # Optional (but recommended)
  54. #
  55. --certificatesresolvers.myresolver.acme.tlschallenge=true
  57. # Use a HTTP-01 ACME challenge.
  58. #
  59. # Optional
  60. #
  61. --certificatesresolvers.myresolver.acme.httpchallenge=true
  63. # EntryPoint to use for the HTTP-01 challenges.
  64. #
  65. # Required
  66. #
  67. --certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web
  69. # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  70. # Note: mandatory for wildcard certificate generation.
  71. #
  72. # Optional
  73. #
  74. --certificatesresolvers.myresolver.acme.dnschallenge=true
  76. # DNS provider used.
  77. #
  78. # Required
  79. #
  80. --certificatesresolvers.myresolver.acme.dnschallenge.provider=digitalocean
  82. # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  83. # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  84. # Useful if internal networks block external DNS queries.
  85. #
  86. # Optional
  87. # Default: 0
  88. #
  89. --certificatesresolvers.myresolver.acme.dnschallenge.delaybeforecheck=0
  91. # Use following DNS servers to resolve the FQDN authority.
  92. #
  93. # Optional
  94. # Default: empty
  95. #
  96. --certificatesresolvers.myresolver.acme.dnschallenge.resolvers=1.1.1.1:53,8.8.8.8:53
  98. # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  99. #
  100. # NOT RECOMMENDED:
  101. # Increase the risk of reaching Let's Encrypt's rate limits.
  102. #
  103. # Optional
  104. # Default: false
  105. #
  106. --certificatesresolvers.myresolver.acme.dnschallenge.disablepropagationcheck=true

Domain Definition

Certificate resolvers request certificates for a set of the domain names inferred from routers, with the following logic:

  • If the router has a tls.domains option set, then the certificate resolver uses the main (and optionally sans) option of tls.domains to know the domain names for this router.

  • If no tls.domains option is set, then the certificate resolver uses the router’s rule, by checking the Host() matchers. Please note that multiple Host() matchers can be used) for specifying multiple domain names for this router.

Please note that:

Please check the configuration examples below for more details.

Configuration Examples

Enabling ACME

File (YAML)

  1. entryPoints:
  2.   web:
  3.     address: ":80"
  5.   websecure:
  6.     address: ":443"
  8. certificatesResolvers:
  9.   myresolver:
  10.     acme:
  11.       email: your-email@example.com
  12.       storage: acme.json
  13.       httpChallenge:
  14.         # used during the challenge
  15.         entryPoint: web

File (TOML)

  1. [entryPoints]
  2.   [entryPoints.web]
  3.     address = ":80"
  5.   [entryPoints.websecure]
  6.     address = ":443"
  8. [certificatesResolvers.myresolver.acme]
  9.   email = "your-email@example.com"
  10.   storage = "acme.json"
  11.   [certificatesResolvers.myresolver.acme.httpChallenge]
  12.     # used during the challenge
  13.     entryPoint = "web"

CLI

  1. --entrypoints.web.address=:80
  2. --entrypoints.websecure.address=:443
  3. # ...
  4. --certificatesresolvers.myresolver.acme.email=your-email@example.com
  5. --certificatesresolvers.myresolver.acme.storage=acme.json
  6. # used during the challenge
  7. --certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web

Defining a certificate resolver does not result in all routers automatically using it. Each router that is supposed to use the resolver must reference it.

Single Domain from Router’s Rule Example

  • A certificate for the domain example.com is requested:

Docker

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver

Docker (Swarm)

  1. ## Dynamic configuration
  2. deploy:
  3.   labels:
  4.     - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  5.     - traefik.http.routers.blog.tls=true
  6.     - traefik.http.routers.blog.tls.certresolver=myresolver
  7.     - traefik.http.services.blog-svc.loadbalancer.server.port=8080"

Kubernetes

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: IngressRoute
  3. metadata:
  4.   name: blogtls
  5. spec:
  6.   entryPoints:
  7.     - websecure
  8.   routes:
  9.   - match: Host(`example.com`) && Path(`/blog`)
  10.     kind: Rule
  11.     services:
  12.     - name: blog
  13.       port: 8080
  14.   tls:
  15.     certResolver: myresolver

Marathon

  1. labels: {
  2.   "traefik.http.routers.blog.rule": "Host(`example.com`) && Path(`/blog`)",
  3.   "traefik.http.routers.blog.tls": "true",
  4.   "traefik.http.routers.blog.tls.certresolver": "myresolver",
  5.   "traefik.http.services.blog-svc.loadbalancer.server.port": "8080"
  6. }

Rancher

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver

File (YAML)

  1. ## Dynamic configuration
  2. http:
  3.   routers:
  4.     blog:
  5.       rule: "Host(`example.com`) && Path(`/blog`)"
  6.       tls:
  7.         certResolver: myresolver

File (TOML)

  1. ## Dynamic configuration
  2. [http.routers]
  3.   [http.routers.blog]
  4.   rule = "Host(`example.com`) && Path(`/blog`)"
  5.   [http.routers.blog.tls]
  6.     certResolver = "myresolver"

Multiple Domains from Router’s Rule Example

  • A certificate for the domains example.com (main) and blog.example.org is requested:

Docker

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver

Docker (Swarm)

  1. ## Dynamic configuration
  2. deploy:
  3.   labels:
  4.     - traefik.http.routers.blog.rule=(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)
  5.     - traefik.http.routers.blog.tls=true
  6.     - traefik.http.routers.blog.tls.certresolver=myresolver
  7.     - traefik.http.services.blog-svc.loadbalancer.server.port=8080"

Kubernetes

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: IngressRoute
  3. metadata:
  4.   name: blogtls
  5. spec:
  6.   entryPoints:
  7.     - websecure
  8.   routes:
  9.   - match: (Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)
  10.     kind: Rule
  11.     services:
  12.     - name: blog
  13.       port: 8080
  14.   tls:
  15.     certResolver: myresolver

Marathon

  1. labels: {
  2.   "traefik.http.routers.blog.rule": "(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)",
  3.   "traefik.http.routers.blog.tls": "true",
  4.   "traefik.http.routers.blog.tls.certresolver": "myresolver",
  5.   "traefik.http.services.blog-svc.loadbalancer.server.port": "8080"
  6. }

Rancher

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver

File (YAML)

  1. ## Dynamic configuration
  2. http:
  3.   routers:
  4.     blog:
  5.       rule: "(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)"
  6.       tls:
  7.         certResolver: myresolver

File (TOML)

  1. ## Dynamic configuration
  2. [http.routers]
  3.   [http.routers.blog]
  4.     rule = "(Host(`example.com`) && Path(`/blog`)) || Host(`blog.example.org`)"
  5.     [http.routers.blog.tls]
  6.       certResolver = "myresolver"

Multiple Domains from Router’s tls.domain Example

  • A certificate for the domains example.com (main) and *.example.org (SAN) is requested:

Docker

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver
  6.   - traefik.http.routers.blog.tls.domains[0].main=example.org
  7.   - traefik.http.routers.blog.tls.domains[0].sans=*.example.org

Docker (Swarm)

  1. ## Dynamic configuration
  2. deploy:
  3.   labels:
  4.     - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  5.     - traefik.http.services.blog-svc.loadbalancer.server.port=8080"
  6.     - traefik.http.routers.blog.tls=true
  7.     - traefik.http.routers.blog.tls.certresolver=myresolver
  8.     - traefik.http.routers.blog.tls.domains[0].main=example.org
  9.     - traefik.http.routers.blog.tls.domains[0].sans=*.example.org

Kubernetes

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: IngressRoute
  3. metadata:
  4.   name: blogtls
  5. spec:
  6.   entryPoints:
  7.     - websecure
  8.   routes:
  9.   - match: Host(`example.com`) && Path(`/blog`)
  10.     kind: Rule
  11.     services:
  12.     - name: blog
  13.       port: 8080
  14.   tls:
  15.     certResolver: myresolver
  16.     domains:
  17.     - main: example.org
  18.       sans:
  19.       - '*.example.org'

Marathon

  1. labels: {
  2.   "traefik.http.routers.blog.rule": "Host(`example.com`) && Path(`/blog`)",
  3.   "traefik.http.routers.blog.tls": "true",
  4.   "traefik.http.routers.blog.tls.certresolver": "myresolver",
  5.   "traefik.http.routers.blog.tls.domains[0].main": "example.com",
  6.   "traefik.http.routers.blog.tls.domains[0].sans": "*.example.com",
  7.   "traefik.http.services.blog-svc.loadbalancer.server.port": "8080"
  8. }

Rancher

  1. ## Dynamic configuration
  2. labels:
  3.   - traefik.http.routers.blog.rule=Host(`example.com`) && Path(`/blog`)
  4.   - traefik.http.routers.blog.tls=true
  5.   - traefik.http.routers.blog.tls.certresolver=myresolver
  6.   - traefik.http.routers.blog.tls.domains[0].main=example.org
  7.   - traefik.http.routers.blog.tls.domains[0].sans=*.example.org

File (YAML)

  1. ## Dynamic configuration
  2. http:
  3.   routers:
  4.     blog:
  5.       rule: "Host(`example.com`) && Path(`/blog`)"
  6.       tls:
  7.         certResolver: myresolver
  8.         domains:
  9.           - main: "example.org"
  10.             sans:
  11.               - "*.example.org"

File (TOML)

  1. ## Dynamic configuration
  2. [http.routers]
  3.   [http.routers.blog]
  4.     rule = "Host(`example.com`) && Path(`/blog`)"
  5.     [http.routers.blog.tls]
  6.       certResolver = "myresolver" # From static configuration
  7.       [[http.routers.blog.tls.domains]]
  8.         main = "example.org"
  9.         sans = ["*.example.org"]

Automatic Renewals

Traefik automatically tracks the expiry date of ACME certificates it generates.

By default, Traefik manages 90 days certificates, and starts to renew certificates 30 days before their expiry.

When using a certificate resolver that issues certificates with custom durations, one can configure the certificates’ duration with the certificatesDuration option.

Certificates that are no longer used may still be renewed, as Traefik does not currently check if the certificate is being used before renewing.

Using LetsEncrypt with Kubernetes

When using LetsEncrypt with kubernetes, there are some known caveats with both the ingress and crd providers.

If you intend to run multiple instances of Traefik with LetsEncrypt, please ensure you read the sections on those provider pages.

The Different ACME Challenges

Defining one ACME challenge is a requirement for a certificate resolver to be functional.

Defining a certificate resolver does not result in all routers automatically using it. Each router that is supposed to use the resolver must reference it.

tlsChallenge

Use the TLS-ALPN-01 challenge to generate and renew ACME certificates by provisioning a TLS certificate.

As described on the Let’s Encrypt community forum, when using the TLS-ALPN-01 challenge, Traefik must be reachable by Let’s Encrypt through port 443.

Configuring the tlsChallenge

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       tlsChallenge: {}

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.tlsChallenge]

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.tlschallenge=true

httpChallenge

Use the HTTP-01 challenge to generate and renew ACME certificates by provisioning an HTTP resource under a well-known URI.

As described on the Let’s Encrypt community forum, when using the HTTP-01 challenge, certificatesresolvers.myresolver.acme.httpchallenge.entrypoint must be reachable by Let’s Encrypt through port 80.

Using an EntryPoint Called web for the httpChallenge

File (YAML)

  1. entryPoints:
  2.   web:
  3.     address: ":80"
  5.   websecure:
  6.     address: ":443"
  8. certificatesResolvers:
  9.   myresolver:
  10.     acme:
  11.       # ...
  12.       httpChallenge:
  13.         entryPoint: web

File (TOML)

  1. [entryPoints]
  2.   [entryPoints.web]
  3.     address = ":80"
  5.   [entryPoints.websecure]
  6.     address = ":443"
  8. [certificatesResolvers.myresolver.acme]
  9.   # ...
  10.   [certificatesResolvers.myresolver.acme.httpChallenge]
  11.     entryPoint = "web"

CLI

  1. --entrypoints.web.address=:80
  2. --entrypoints.websecure.address=:443
  3. # ...
  4. --certificatesresolvers.myresolver.acme.httpchallenge.entrypoint=web

Redirection is fully compatible with the HTTP-01 challenge.

dnsChallenge

Use the DNS-01 challenge to generate and renew ACME certificates by provisioning a DNS record.

Configuring a dnsChallenge with the DigitalOcean Provider

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       dnsChallenge:
  6.         provider: digitalocean
  7.         delayBeforeCheck: 0
  8.     # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.dnsChallenge]
  4.     provider = "digitalocean"
  5.     delayBeforeCheck = 0
  6. # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.dnschallenge.provider=digitalocean
  3. --certificatesresolvers.myresolver.acme.dnschallenge.delaybeforecheck=0
  4. # ...

Important

A provider is mandatory.

providers

Here is a list of supported providers, that can automate the DNS verification, along with the required environment variables and their wildcard & root domain support. Do not hesitate to complete it.

Many lego environment variables can be overridden by their respective _FILE counterpart, which should have a filepath to a file that contains the secret as its value. For example, CF_API_EMAIL_FILE=/run/secrets/traefik_cf-api-email could be used to provide a Cloudflare API email address as a Docker secret named traefik_cf-api-email.

For complete details, refer to your provider’s Additional configuration link.

Provider NameProvider CodeEnvironment Variables
ACME DNSacme-dnsACME_DNS_API_BASE, ACME_DNS_STORAGE_PATHAdditional configuration
Alibaba CloudalidnsALICLOUD_ACCESS_KEY, ALICLOUD_SECRET_KEY, ALICLOUD_REGION_IDAdditional configuration
all-inklallinklALL_INKL_LOGIN, ALL_INKL_PASSWORDAdditional configuration
ArvanCloudarvancloudARVANCLOUD_API_KEYAdditional configuration
AuroradnsauroradnsAURORA_USER_ID, AURORA_KEY, AURORA_ENDPOINTAdditional configuration
AutodnsautodnsAUTODNS_API_USER, AUTODNS_API_PASSWORDAdditional configuration
AzureazureAZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, AZURE_RESOURCE_GROUP, [AZURE_METADATA_ENDPOINT]Additional configuration
BindmanbindmanBINDMAN_MANAGER_ADDRESSAdditional configuration
Blue CatbluecatBLUECAT_SERVER_URL, BLUECAT_USER_NAME, BLUECAT_PASSWORD, BLUECAT_CONFIG_NAME, BLUECAT_DNS_VIEWAdditional configuration
CheckdomaincheckdomainCHECKDOMAIN_TOKEN,Additional configuration
CloudDNSclouddnsCLOUDDNS_CLIENT_ID, CLOUDDNS_EMAIL, CLOUDDNS_PASSWORDAdditional configuration
CloudflarecloudflareCF_API_EMAIL, CF_API_KEY 5 or CF_DNS_API_TOKEN, [CF_ZONE_API_TOKEN]Additional configuration
ClouDNScloudnsCLOUDNS_AUTH_ID, CLOUDNS_AUTH_PASSWORDAdditional configuration
CloudXNScloudxnsCLOUDXNS_API_KEY, CLOUDXNS_SECRET_KEYAdditional configuration
ConoHaconohaCONOHA_TENANT_ID, CONOHA_API_USERNAME, CONOHA_API_PASSWORDAdditional configuration
ConstellixconstellixCONSTELLIX_API_KEY, CONSTELLIX_SECRET_KEYAdditional configuration
deSECdesecDESEC_TOKENAdditional configuration
DigitalOceandigitaloceanDO_AUTH_TOKENAdditional configuration
DNS Made EasydnsmadeeasyDNSMADEEASY_API_KEY, DNSMADEEASY_API_SECRET, DNSMADEEASY_SANDBOXAdditional configuration
DNSimplednsimpleDNSIMPLE_OAUTH_TOKEN, DNSIMPLE_BASE_URLAdditional configuration
DNSPoddnspodDNSPOD_API_KEYAdditional configuration
Domain Offensive (do.de)dodeDODE_TOKENAdditional configuration
DomeneshopdomeneshopDOMENESHOP_API_TOKEN, DOMENESHOP_API_SECRETAdditional configuration
DreamHostdreamhostDREAMHOST_API_KEYAdditional configuration
Duck DNSduckdnsDUCKDNS_TOKENAdditional configuration
DyndynDYN_CUSTOMER_NAME, DYN_USER_NAME, DYN_PASSWORDAdditional configuration
DynudynuDYNU_API_KEYAdditional configuration
EasyDNSeasydnsEASYDNS_TOKEN, EASYDNS_KEYAdditional configuration
EdgeDNSedgednsAKAMAI_CLIENT_TOKEN, AKAMAI_CLIENT_SECRET, AKAMAI_ACCESS_TOKENAdditional configuration
EpikepikEPIK_SIGNATUREAdditional configuration
ExoscaleexoscaleEXOSCALE_API_KEY, EXOSCALE_API_SECRET, EXOSCALE_ENDPOINTAdditional configuration
Fast DNSfastdnsAKAMAI_CLIENT_TOKEN, AKAMAI_CLIENT_SECRET, AKAMAI_ACCESS_TOKENAdditional configuration
Freemyip.comfreemyipFREEMYIP_TOKENAdditional configuration
G-Core LabgcoreGCORE_PERMANENT_API_TOKENAdditional configuration
Gandi v5gandiv5GANDIV5_API_KEYAdditional configuration
GandigandiGANDI_API_KEYAdditional configuration
GlesysglesysGLESYS_API_USER, GLESYS_API_KEY, GLESYS_DOMAINAdditional configuration
GoDaddygodaddyGODADDY_API_KEY, GODADDY_API_SECRETAdditional configuration
Google Cloud DNSgcloudGCE_PROJECT, Application Default Credentials 2 3, [GCE_SERVICE_ACCOUNT_FILE]Additional configuration
HetznerhetznerHETZNER_API_KEYAdditional configuration
hosting.dehostingdeHOSTINGDE_API_KEY, HOSTINGDE_ZONE_NAMEAdditional configuration
HosttechhosttechHOSTTECH_API_KEYAdditional configuration
Hurricane ElectrichurricaneHURRICANE_TOKENS 6Additional configuration
HyperOnehyperoneHYPERONE_PASSPORT_LOCATION, HYPERONE_LOCATION_IDAdditional configuration
IBM Cloud (SoftLayer)ibmcloudSOFTLAYER_USERNAME, SOFTLAYER_API_KEYAdditional configuration
IIJ DNS Platform ServiceiijdpfIIJ_DPF_API_TOKEN , IIJ_DPF_DPM_SERVICE_CODEAdditional configuration
IIJiijIIJ_API_ACCESS_KEY, IIJ_API_SECRET_KEY, IIJ_DO_SERVICE_CODEAdditional configuration
InfobloxinfobloxINFOBLOX_USER, INFOBLOX_PASSWORD, INFOBLOX_HOSTAdditional configuration
InfomaniakinfomaniakINFOMANIAK_ACCESS_TOKENAdditional configuration
Internet.bsinternetbsINTERNET_BS_API_KEY, INTERNET_BS_PASSWORDAdditional configuration
INWXinwxINWX_USERNAME, INWX_PASSWORDAdditional configuration
ionosionosIONOS_API_KEYAdditional configuration
iwantmynameiwantmynameIWANTMYNAME_USERNAME , IWANTMYNAME_PASSWORDAdditional configuration
Joker.comjokerJOKER_API_MODE with JOKER_API_KEY or JOKER_USERNAME, JOKER_PASSWORDAdditional configuration
LightsaillightsailAWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, DNS_ZONEAdditional configuration
Linode v4linodeLINODE_TOKENAdditional configuration
Liquid WebliquidwebLIQUID_WEB_PASSWORD, LIQUID_WEB_USERNAME, LIQUID_WEB_ZONEAdditional configuration
LoopialoopiaLOOPIA_API_PASSWORD, LOOPIA_API_USERAdditional configuration
LuaDNSluadnsLUADNS_API_USERNAME, LUADNS_API_TOKENAdditional configuration
MyDNS.jpmydnsjpMYDNSJP_MASTER_ID, MYDNSJP_PASSWORDAdditional configuration
Mythic BeastsmythicbeastsMYTHICBEASTS_USER_NAME, MYTHICBEASTS_PASSWORDAdditional configuration
name.comnamedotcomNAMECOM_USERNAME, NAMECOM_API_TOKEN, NAMECOM_SERVERAdditional configuration
NamecheapnamecheapNAMECHEAP_API_USER, NAMECHEAP_API_KEYAdditional configuration
NamesilonamesiloNAMESILO_API_KEYAdditional configuration
NetcupnetcupNETCUP_CUSTOMER_NUMBER, NETCUP_API_KEY, NETCUP_API_PASSWORDAdditional configuration
NetlifynetlifyNETLIFY_TOKENAdditional configuration
NicmanagernicmanagerNICMANAGER_API_EMAIL, NICMANAGER_API_PASSWORDAdditional configuration
NIFCloudnifcloudNIFCLOUD_ACCESS_KEY_ID, NIFCLOUD_SECRET_ACCESS_KEYAdditional configuration
NjallanjallaNJALLA_TOKENAdditional configuration
NS1ns1NS1_API_KEYAdditional configuration
Open Telekom CloudotcOTC_DOMAIN_NAME, OTC_USER_NAME, OTC_PASSWORD, OTC_PROJECT_NAME, OTC_IDENTITY_ENDPOINTAdditional configuration
Openstack DesignatedesignateOS_AUTH_URL, OS_USERNAME, OS_PASSWORD, OS_TENANT_NAME, OS_REGION_NAMEAdditional configuration
Oracle CloudoraclecloudOCI_COMPARTMENT_OCID, OCI_PRIVKEY_FILE, OCI_PRIVKEY_PASS, OCI_PUBKEY_FINGERPRINT, OCI_REGION, OCI_TENANCY_OCID, OCI_USER_OCIDAdditional configuration
OVHovhOVH_ENDPOINT, OVH_APPLICATION_KEY, OVH_APPLICATION_SECRET, OVH_CONSUMER_KEYAdditional configuration
PorkbunporkbunPORKBUN_SECRET_API_KEY, PORKBUN_API_KEYAdditional configuration
PowerDNSpdnsPDNS_API_KEY, PDNS_API_URLAdditional configuration
RackspacerackspaceRACKSPACE_USER, RACKSPACE_API_KEYAdditional configuration
reg.ruregruREGRU_USERNAME, REGRU_PASSWORDAdditional configuration
RFC2136rfc2136RFC2136_TSIG_KEY, RFC2136_TSIG_SECRET, RFC2136_TSIG_ALGORITHM, RFC2136_NAMESERVERAdditional configuration
RimuHostingrimuhostingRIMUHOSTING_API_KEYAdditional configuration
Route 53route53AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, [AWS_REGION], [AWS_HOSTED_ZONE_ID] or a configured user/instance IAM profile.Additional configuration
Sakura CloudsakuracloudSAKURACLOUD_ACCESS_TOKEN, SAKURACLOUD_ACCESS_TOKEN_SECRETAdditional configuration
ScalewayscalewaySCALEWAY_API_TOKENAdditional configuration
SelectelselectelSELECTEL_API_TOKENAdditional configuration
ServercowservercowSERVERCOW_USERNAME, SERVERCOW_PASSWORDAdditional configuration
Simply.comsimplySIMPLY_ACCOUNT_NAME, SIMPLY_API_KEYAdditional configuration
SonicsonicSONIC_USER_ID, SONIC_API_KEYAdditional configuration
StackpathstackpathSTACKPATH_CLIENT_ID, STACKPATH_CLIENT_SECRET, STACKPATH_STACK_IDAdditional configuration
Tencent Cloud DNStencentcloudTENCENTCLOUD_SECRET_ID, TENCENTCLOUD_SECRET_KEYAdditional configuration
TransIPtransipTRANSIP_ACCOUNT_NAME, TRANSIP_PRIVATE_KEY_PATHAdditional configuration
UKFast SafeDNSsafednsSAFEDNS_AUTH_TOKENAdditional configuration
VegaDNSvegadnsSECRET_VEGADNS_KEY, SECRET_VEGADNS_SECRET, VEGADNS_URLAdditional configuration
VercelvercelVERCEL_API_TOKENAdditional configuration
VersioversioVERSIO_USERNAME, VERSIO_PASSWORDAdditional configuration
VinylDNSvinyldnsVINYLDNS_ACCESS_KEY, VINYLDNS_SECRET_KEY, VINYLDNS_HOSTAdditional configuration
VscalevscaleVSCALE_API_TOKENAdditional configuration
VULTRvultrVULTR_API_KEYAdditional configuration
WEDOSwedosWEDOS_USERNAME, WEDOS_WAPI_PASSWORDAdditional configuration
YandexyandexYANDEX_PDD_TOKENAdditional configuration
Zone.eezoneeeZONEEE_API_USER, ZONEEE_API_KEYAdditional configuration
ZonomizonomiZONOMI_API_KEYAdditional configuration
External ProgramexecEXEC_PATHAdditional configuration
HTTP requesthttpreqHTTPREQ_ENDPOINT, HTTPREQ_MODE, HTTPREQ_USERNAME, HTTPREQ_PASSWORD 1Additional configuration
manualmanualnone, but you need to run Traefik interactively 4, turn on debug log to see instructions and press Enter.

delayBeforeCheck

By default, the provider verifies the TXT record before letting ACME verify. You can delay this operation by specifying a delay (in seconds) with delayBeforeCheck (value must be greater than zero). This option is useful when internal networks block external DNS queries.

resolvers

Use custom DNS servers to resolve the FQDN authority.

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       dnsChallenge:
  6.         # ...
  7.         resolvers:
  8.           - "1.1.1.1:53"
  9.           - "8.8.8.8:53"

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.dnsChallenge]
  4.     # ...
  5.     resolvers = ["1.1.1.1:53", "8.8.8.8:53"]

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.dnschallenge.resolvers=1.1.1.1:53,8.8.8.8:53

Wildcard Domains

ACME V2 supports wildcard certificates. As described in Let’s Encrypt’s post wildcard certificates can only be generated through a DNS-01 challenge.

External Account Binding

  • kid: Key identifier from External CA
  • hmacEncoded: HMAC key from External CA, should be in Base64 URL Encoding without padding format

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       eab:
  6.         kid: abc-keyID-xyz
  7.         hmacEncoded: abc-hmac-xyz

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.eab]
  4.     kid = "abc-keyID-xyz"
  5.     hmacEncoded = "abc-hmac-xyz"

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.eab.kid=abc-keyID-xyz
  3. --certificatesresolvers.myresolver.acme.eab.hmacencoded=abc-hmac-xyz

More Configuration

caServer

Required, Default=”https://acme-v02.api.letsencrypt.org/directory“

The CA server to use:

Using the Let’s Encrypt staging server

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       caServer: https://acme-staging-v02.api.letsencrypt.org/directory
  6.       # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   caServer = "https://acme-staging-v02.api.letsencrypt.org/directory"
  4.   # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory
  3. # ...

storage

Required, Default=”acme.json”

The storage option sets the location where your ACME certificates are saved to.

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       storage: acme.json
  6.       # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   storage = "acme.json"
  4.   # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.storage=acme.json
  3. # ...

ACME certificates are stored in a JSON file that needs to have a 600 file mode.

In Docker you can mount either the JSON file, or the folder containing it:

  1. docker run -v "/my/host/acme.json:/acme.json" traefik
  1. docker run -v "/my/host/acme:/etc/traefik/acme" traefik

Warning

For concurrency reasons, this file cannot be shared across multiple instances of Traefik.

certificatesDuration

Optional, Default=2160

The certificatesDuration option defines the certificates’ duration in hours. It defaults to 2160 (90 days) to follow Let’s Encrypt certificates’ duration.

Traefik cannot manage certificates with a duration lower than 1 hour.

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       certificatesDuration: 72
  6.       # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   certificatesDuration=72
  4.   # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.certificatesduration=72
  3. # ...

certificatesDuration is used to calculate two durations:

  • Renew Period: the period before the end of the certificate duration, during which the certificate should be renewed.
  • Renew Interval: the interval between renew attempts.
Certificate DurationRenew PeriodRenew Interval
>= 1 year4 months1 week
>= 90 days30 days1 day
>= 7 days1 day1 hour
>= 24 hours6 hours10 min
< 24 hours20 min1 min

preferredChain

Optional, Default=””

Preferred chain to use.

If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If no match, the default offered chain will be used.

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       preferredChain: 'ISRG Root X1'
  6.       # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   preferredChain = "ISRG Root X1"
  4.   # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.preferredChain=ISRG Root X1
  3. # ...

keyType

Optional, Default=”RSA4096”

KeyType used for generating certificate private key. Allow value ‘EC256’, ‘EC384’, ‘RSA2048’, ‘RSA4096’, ‘RSA8192’.

File (YAML)

  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       keyType: 'RSA4096'
  6.       # ...

File (TOML)

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   keyType = "RSA4096"
  4.   # ...

CLI

  1. # ...
  2. --certificatesresolvers.myresolver.acme.keyType=RSA4096
  3. # ...

Fallback

If Let’s Encrypt is not reachable, the following certificates will apply:

  1. Previously generated ACME certificates (before downtime)
  2. Expired ACME certificates
  3. Provided certificates

Important

For new (sub)domains which need Let’s Encrypt authentication, the default Traefik certificate will be used until Traefik is restarted.

  1. More information about the HTTP message format can be found here. ↩

  2. Providing credentials to your application. ↩

  3. google/default.go ↩

  4. docker stack remark: there is no way to support terminal attached to container when deploying with docker stack, so you might need to run container with docker run -it to generate certificates using manual provider. ↩

  5. The Global API Key needs to be used, not the Origin CA Key. ↩

  6. As explained in the LEGO hurricane configuration, each domain or wildcard (record name) needs a token. So each update of record name must be followed by an update of the HURRICANE_TOKENS variable, and a restart of Traefik. ↩