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 a certificates 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:

  1. # Enable ACME (Let's Encrypt): automatic SSL.
  2. [certificatesResolvers.myresolver.acme]
  4.   # Email address used for registration.
  5.   #
  6.   # Required
  7.   #
  8.   email = "[email protected]"
  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.   # KeyType to use.
  26.   #
  27.   # Optional
  28.   # Default: "RSA4096"
  29.   #
  30.   # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  31.   #
  32.   # keyType = "RSA4096"
  34.   # Use a TLS-ALPN-01 ACME challenge.
  35.   #
  36.   # Optional (but recommended)
  37.   #
  38.   [certificatesResolvers.myresolver.acme.tlsChallenge]
  40.   # Use a HTTP-01 ACME challenge.
  41.   #
  42.   # Optional
  43.   #
  44.   # [certificatesResolvers.myresolver.acme.httpChallenge]
  46.     # EntryPoint to use for the HTTP-01 challenges.
  47.     #
  48.     # Required
  49.     #
  50.     # entryPoint = "web"
  52.   # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  53.   # Note: mandatory for wildcard certificate generation.
  54.   #
  55.   # Optional
  56.   #
  57.   # [certificatesResolvers.myresolver.acme.dnsChallenge]
  59.     # DNS provider used.
  60.     #
  61.     # Required
  62.     #
  63.     # provider = "digitalocean"
  65.     # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  66.     # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  67.     # Useful if internal networks block external DNS queries.
  68.     #
  69.     # Optional
  70.     # Default: 0
  71.     #
  72.     # delayBeforeCheck = 0
  74.     # Use following DNS servers to resolve the FQDN authority.
  75.     #
  76.     # Optional
  77.     # Default: empty
  78.     #
  79.     # resolvers = ["1.1.1.1:53", "8.8.8.8:53"]
  81.     # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  82.     #
  83.     # NOT RECOMMENDED:
  84.     # Increase the risk of reaching Let's Encrypt's rate limits.
  85.     #
  86.     # Optional
  87.     # Default: false
  88.     #
  89.     # disablePropagationCheck = true
  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: "[email protected]"
  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.       # KeyType to use.
  28.       #
  29.       # Optional
  30.       # Default: "RSA4096"
  31.       #
  32.       # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  33.       #
  34.       # keyType: RSA4096
  36.       # Use a TLS-ALPN-01 ACME challenge.
  37.       #
  38.       # Optional (but recommended)
  39.       #
  40.       tlsChallenge:
  42.       # Use a HTTP-01 ACME challenge.
  43.       #
  44.       # Optional
  45.       #
  46.       # httpChallenge:
  48.         # EntryPoint to use for the HTTP-01 challenges.
  49.         #
  50.         # Required
  51.         #
  52.         # entryPoint: web
  54.       # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  55.       # Note: mandatory for wildcard certificate generation.
  56.       #
  57.       # Optional
  58.       #
  59.       # dnsChallenge:
  61.         # DNS provider used.
  62.         #
  63.         # Required
  64.         #
  65.         # provider: digitalocean
  67.         # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  68.         # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  69.         # Useful if internal networks block external DNS queries.
  70.         #
  71.         # Optional
  72.         # Default: 0
  73.         #
  74.         # delayBeforeCheck: 0
  76.         # Use following DNS servers to resolve the FQDN authority.
  77.         #
  78.         # Optional
  79.         # Default: empty
  80.         #
  81.         # resolvers
  82.         # - "1.1.1.1:53"
  83.         # - "8.8.8.8:53"
  85.         # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  86.         #
  87.         # NOT RECOMMENDED:
  88.         # Increase the risk of reaching Let's Encrypt's rate limits.
  89.         #
  90.         # Optional
  91.         # Default: false
  92.         #
  93.         # disablePropagationCheck: true
  1. # Enable ACME (Let's Encrypt): automatic SSL.
  3. # Email address used for registration.
  4. #
  5. # Required
  6. #
  7. [email protected]
  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. # KeyType to use.
  25. #
  26. # Optional
  27. # Default: "RSA4096"
  28. #
  29. # Available values : "EC256", "EC384", "RSA2048", "RSA4096", "RSA8192"
  30. #
  31. --certificatesResolvers.myresolver.acme.keyType=RSA4096
  33. # Use a TLS-ALPN-01 ACME challenge.
  34. #
  35. # Optional (but recommended)
  36. #
  37. --certificatesResolvers.myresolver.acme.tlsChallenge=true
  39. # Use a HTTP-01 ACME challenge.
  40. #
  41. # Optional
  42. #
  43. --certificatesResolvers.myresolver.acme.httpChallenge=true
  45. # EntryPoint to use for the HTTP-01 challenges.
  46. #
  47. # Required
  48. #
  49. --certificatesResolvers.myresolver.acme.httpChallenge.entryPoint=web
  51. # Use a DNS-01 ACME challenge rather than HTTP-01 challenge.
  52. # Note: mandatory for wildcard certificate generation.
  53. #
  54. # Optional
  55. #
  56. --certificatesResolvers.myresolver.acme.dnsChallenge=true
  58. # DNS provider used.
  59. #
  60. # Required
  61. #
  62. --certificatesResolvers.myresolver.acme.dnsChallenge.provider=digitalocean
  64. # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
  65. # If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.
  66. # Useful if internal networks block external DNS queries.
  67. #
  68. # Optional
  69. # Default: 0
  70. #
  71. --certificatesResolvers.myresolver.acme.dnsChallenge.delayBeforeCheck=0
  73. # Use following DNS servers to resolve the FQDN authority.
  74. #
  75. # Optional
  76. # Default: empty
  77. #
  78. --certificatesResolvers.myresolver.acme.dnsChallenge.resolvers=1.1.1.1:53,8.8.8.8:53
  80. # Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready.
  81. #
  82. # NOT RECOMMENDED:
  83. # Increase the risk of reaching Let's Encrypt's rate limits.
  84. #
  85. # Optional
  86. # Default: false
  87. #
  88. --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

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

Defining a certificates 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: 
  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
  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"
  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
  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. }
  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
  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"
  1. ## Dynamic configuration
  2. http:
  3.   routers:
  4.     blog:
  5.       rule: "Host(`example.com`) && Path(`/blog`)"
  6.       tls:
  7.         certResolver: myresolver

Multiple Domains from Router's Rule Example

  • A certificate for the domains example.com (main) and blog.example.org is requested: 
  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
  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"
  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
  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. }
  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
  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"
  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

Multiple Domains from Router's tls.domain Example

  • A certificate for the domains example.com (main) and *.example.org (SAN) is requested: 
  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
  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
  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
  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. }
  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
  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"]
  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"

Automatic Renewals

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

If there are less than 30 days remaining before the certificate expires, Traefik will attempt to renew it automatically.

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 a certificates 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

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.tlsChallenge]
  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       tlsChallenge: {}
  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

  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"
  1. entryPoints:
  2.   web:
  3.     address: ":80"
  5.   websecure:
  6.     address: ":443"
  8. certificatesResolvers:
  9.   myresolver:
  10.     acme:
  11.       # ...
  12.       httpChallenge:
  13.         entryPoint: web
  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

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.dnsChallenge]
  4.     provider = "digitalocean"
  5.     delayBeforeCheck = 0
  6. # ...
  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       dnsChallenge:
  6.         provider: digitalocean
  7.         delayBeforeCheck: 0
  8.     # ...
  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.

Every lego environment variable 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.

Provider Name Provider Code Environment Variables
ACME DNS acme-dns ACME_DNS_API_BASE, ACME_DNS_STORAGE_PATH Additional configuration
Alibaba Cloud alidns ALICLOUD_ACCESS_KEY, ALICLOUD_SECRET_KEY, ALICLOUD_REGION_ID Additional configuration
Auroradns auroradns AURORA_USER_ID, AURORA_KEY, AURORA_ENDPOINT Additional configuration
Autodns autodns AUTODNS_API_USER, AUTODNS_API_PASSWORD Additional configuration
Azure azure AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, AZURE_RESOURCE_GROUP, [AZURE_METADATA_ENDPOINT] Additional configuration
Bindman bindman BINDMAN_MANAGER_ADDRESS Additional configuration
Blue Cat bluecat BLUECAT_SERVER_URL, BLUECAT_USER_NAME, BLUECAT_PASSWORD, BLUECAT_CONFIG_NAME, BLUECAT_DNS_VIEW Additional configuration
Checkdomain checkdomain CHECKDOMAIN_TOKEN, Additional configuration
CloudDNS clouddns CLOUDDNS_CLIENT_ID, CLOUDDNS_EMAIL, CLOUDDNS_PASSWORD Additional configuration
ClouDNS cloudns CLOUDNS_AUTH_ID, CLOUDNS_AUTH_PASSWORD Additional configuration
Cloudflare cloudflare CF_API_EMAIL, CF_API_KEY 5 or CF_DNS_API_TOKEN, [CF_ZONE_API_TOKEN] Additional configuration
CloudXNS cloudxns CLOUDXNS_API_KEY, CLOUDXNS_SECRET_KEY Additional configuration
ConoHa conoha CONOHA_TENANT_ID, CONOHA_API_USERNAME, CONOHA_API_PASSWORD Additional configuration
Constellix constellix CONSTELLIX_API_KEY, CONSTELLIX_SECRET_KEY Additional configuration
DigitalOcean digitalocean DO_AUTH_TOKEN Additional configuration
DNSimple dnsimple DNSIMPLE_OAUTH_TOKEN, DNSIMPLE_BASE_URL Additional configuration
DNS Made Easy dnsmadeeasy DNSMADEEASY_API_KEY, DNSMADEEASY_API_SECRET, DNSMADEEASY_SANDBOX Additional configuration
DNSPod dnspod DNSPOD_API_KEY Additional configuration
Domain Offensive (do.de) dode DODE_TOKEN Additional configuration
DreamHost dreamhost DREAMHOST_API_KEY Additional configuration
Duck DNS duckdns DUCKDNS_TOKEN Additional configuration
Dyn dyn DYN_CUSTOMER_NAME, DYN_USER_NAME, DYN_PASSWORD Additional configuration
Dynu dynu DYNU_API_KEY Additional configuration
EasyDNS easydns EASYDNS_TOKEN, EASYDNS_KEY Additional configuration
External Program exec EXEC_PATH Additional configuration
Exoscale exoscale EXOSCALE_API_KEY, EXOSCALE_API_SECRET, EXOSCALE_ENDPOINT Additional configuration
Fast DNS fastdns AKAMAI_CLIENT_TOKEN, AKAMAI_CLIENT_SECRET, AKAMAI_ACCESS_TOKEN Additional configuration
Gandi gandi GANDI_API_KEY Additional configuration
Gandi v5 gandiv5 GANDIV5_API_KEY Additional configuration
Glesys glesys GLESYS_API_USER, GLESYS_API_KEY, GLESYS_DOMAIN Additional configuration
GoDaddy godaddy GODADDY_API_KEY, GODADDY_API_SECRET Additional configuration
Google Cloud DNS gcloud GCE_PROJECT, Application Default Credentials 2 3, [GCE_SERVICE_ACCOUNT_FILE] Additional configuration
hosting.de hostingde HOSTINGDE_API_KEY, HOSTINGDE_ZONE_NAME Additional configuration
HTTP request httpreq HTTPREQ_ENDPOINT, HTTPREQ_MODE, HTTPREQ_USERNAME, HTTPREQ_PASSWORD 1 Additional configuration
IIJ iij IIJ_API_ACCESS_KEY, IIJ_API_SECRET_KEY, IIJ_DO_SERVICE_CODE Additional configuration
INWX inwx INWX_USERNAME, INWX_PASSWORD Additional configuration
Joker.com joker JOKER_API_KEY or JOKER_USERNAME, JOKER_PASSWORD Additional configuration
Lightsail lightsail AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, DNS_ZONE Additional configuration
Linode linode LINODE_API_KEY Additional configuration
Linode v4 linodev4 LINODE_TOKEN Additional configuration
Liquid Web liquidweb LIQUID_WEB_PASSWORD, LIQUID_WEB_USERNAME, LIQUID_WEB_ZONE Additional configuration
manual manual none, but you need to run Traefik interactively 4, turn on debug log to see instructions and press Enter.
MyDNS.jp mydnsjp MYDNSJP_MASTER_ID, MYDNSJP_PASSWORD Additional configuration
Namecheap namecheap NAMECHEAP_API_USER, NAMECHEAP_API_KEY Additional configuration
name.com namedotcom NAMECOM_USERNAME, NAMECOM_API_TOKEN, NAMECOM_SERVER Additional configuration
Namesilo namesilo NAMESILO_API_KEY Additional configuration
Netcup netcup NETCUP_CUSTOMER_NUMBER, NETCUP_API_KEY, NETCUP_API_PASSWORD Additional configuration
NIFCloud nifcloud NIFCLOUD_ACCESS_KEY_ID, NIFCLOUD_SECRET_ACCESS_KEY Additional configuration
Ns1 ns1 NS1_API_KEY Additional configuration
Open Telekom Cloud otc OTC_DOMAIN_NAME, OTC_USER_NAME, OTC_PASSWORD, OTC_PROJECT_NAME, OTC_IDENTITY_ENDPOINT Additional configuration
OVH ovh OVH_ENDPOINT, OVH_APPLICATION_KEY, OVH_APPLICATION_SECRET, OVH_CONSUMER_KEY Additional configuration
Openstack Designate designate OS_AUTH_URL, OS_USERNAME, OS_PASSWORD, OS_TENANT_NAME, OS_REGION_NAME Additional configuration
Oracle Cloud oraclecloud OCI_COMPARTMENT_OCID, OCI_PRIVKEY_FILE, OCI_PRIVKEY_PASS, OCI_PUBKEY_FINGERPRINT, OCI_REGION, OCI_TENANCY_OCID, OCI_USER_OCID Additional configuration
PowerDNS pdns PDNS_API_KEY, PDNS_API_URL Additional configuration
Rackspace rackspace RACKSPACE_USER, RACKSPACE_API_KEY Additional configuration
reg.ru regru REGRU_USERNAME, REGRU_PASSWORD Additional configuration
RFC2136 rfc2136 RFC2136_TSIG_KEY, RFC2136_TSIG_SECRET, RFC2136_TSIG_ALGORITHM, RFC2136_NAMESERVER Additional configuration
Route 53 route53 AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, [AWS_REGION], [AWS_HOSTED_ZONE_ID] or a configured user/instance IAM profile. Additional configuration
RimuHosting rimuhosting RIMUHOSTING_API_KEY Additional configuration
Sakura Cloud sakuracloud SAKURACLOUD_ACCESS_TOKEN, SAKURACLOUD_ACCESS_TOKEN_SECRET Additional configuration
Scaleway scaleway SCALEWAY_API_TOKEN Additional configuration
Selectel selectel SELECTEL_API_TOKEN Additional configuration
Servercow servercow SERVERCOW_USERNAME, SERVERCOW_PASSWORD Additional configuration
Stackpath stackpath STACKPATH_CLIENT_ID, STACKPATH_CLIENT_SECRET, STACKPATH_STACK_ID Additional configuration
TransIP transip TRANSIP_ACCOUNT_NAME, TRANSIP_PRIVATE_KEY_PATH Additional configuration
VegaDNS vegadns SECRET_VEGADNS_KEY, SECRET_VEGADNS_SECRET, VEGADNS_URL Additional configuration
Versio versio VERSIO_USERNAME, VERSIO_PASSWORD Additional configuration
Vscale vscale VSCALE_API_TOKEN Additional configuration
VULTR vultr VULTR_API_KEY Additional configuration
Zone.ee zoneee ZONEEE_API_USER, ZONEEE_API_KEY Additional configuration
Zonomi zonomi ZONOMI_API_KEY Additional configuration

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.

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   [certificatesResolvers.myresolver.acme.dnsChallenge]
  4.     # ...
  5.     resolvers = ["1.1.1.1:53", "8.8.8.8:53"]
  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       dnsChallenge:
  6.         # ...
  7.         resolvers:
  8.           - "1.1.1.1:53"
  9.           - "8.8.8.8:53"
  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.

More Configuration

caServer

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

The CA server to use:

Using the Let's Encrypt staging server

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   caServer = "https://acme-staging-v02.api.letsencrypt.org/directory"
  4.   # ...
  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       caServer: https://acme-staging-v02.api.letsencrypt.org/directory
  6.       # ...
  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.

  1. [certificatesResolvers.myresolver.acme]
  2.   # ...
  3.   storage = "acme.json"
  4.   # ...
  1. certificatesResolvers:
  2.   myresolver:
  3.     acme:
  4.       # ...
  5.       storage: acme.json
  6.       # ...
  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 reason, this file cannot be shared across multiple instances of Traefik.

Fallback

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

  • Previously generated ACME certificates (before downtime)
  • Expired ACME certificates
  • Provided certificates

Important

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

  • more information about the HTTP message format can be found here ↩

  • providing_credentials_to_your_application ↩

  • google/default.go ↩

  • 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. ↩

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