57 KiB
Docker Provider
Traefik can be configured to use Docker as a provider.
Docker
################################################################
# Docker Provider
################################################################
# Enable Docker Provider.
[docker]
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
#
# Required
#
endpoint = "unix:///var/run/docker.sock"
# Default base domain used for the frontend rules.
# Can be overridden by setting the "traefik.domain" label on a container.
#
# Optional
#
domain = "docker.localhost"
# Enable watch docker changes.
#
# Optional
#
watch = true
# Override default configuration template.
# For advanced users :)
#
# Optional
#
# filename = "docker.tmpl"
# Override template version
# For advanced users :)
#
# Optional
# - "1": previous template version (must be used only with older custom templates, see "filename")
# - "2": current template version (must be used to force template version when "filename" is used)
#
# templateVersion = 2
# Expose containers by default in Traefik.
# If set to false, containers that don't have `traefik.enable=true` will be ignored.
#
# Optional
# Default: true
#
exposedByDefault = true
# Use the IP address from the binded port instead of the inner network one.
#
# In case no IP address is attached to the binded port (or in case
# there is no bind), the inner network one will be used as a fallback.
#
# Optional
# Default: false
#
usebindportip = true
# Use Swarm Mode services as data provider.
#
# Optional
# Default: false
#
swarmMode = false
# Polling interval (in seconds) for Swarm Mode.
#
# Optional
# Default: 15
#
swarmModeRefreshSeconds = 15
# Define a default docker network to use for connections to all containers.
# Can be overridden by the traefik.docker.network label.
#
# Optional
#
network = "web"
# Enable docker TLS connection.
#
# Optional
#
# [docker.tls]
# ca = "/etc/ssl/ca.crt"
# cert = "/etc/ssl/docker.crt"
# key = "/etc/ssl/docker.key"
# insecureSkipVerify = true
To enable constraints see provider-specific constraints section.
Docker Swarm Mode
################################################################
# Docker Swarm Mode Provider
################################################################
# Enable Docker Provider.
[docker]
# Docker server endpoint.
# Can be a tcp or a unix socket endpoint.
#
# Required
# Default: "unix:///var/run/docker.sock"
#
# swarm classic (1.12-)
# endpoint = "tcp://127.0.0.1:2375"
# docker swarm mode (1.12+)
endpoint = "tcp://127.0.0.1:2377"
# Default base domain used for the frontend rules.
# Can be overridden by setting the "traefik.domain" label on a services.
#
# Optional
# Default: ""
#
domain = "docker.localhost"
# Enable watch docker changes.
#
# Optional
# Default: true
#
watch = true
# Use Docker Swarm Mode as data provider.
#
# Optional
# Default: false
#
swarmMode = true
# Define a default docker network to use for connections to all containers.
# Can be overridden by the traefik.docker.network label.
#
# Optional
#
network = "web"
# Override default configuration template.
# For advanced users :)
#
# Optional
#
# filename = "docker.tmpl"
# Override template version
# For advanced users :)
#
# Optional
# - "1": previous template version (must be used only with older custom templates, see "filename")
# - "2": current template version (must be used to force template version when "filename" is used)
#
# templateVersion = 2
# Expose services by default in Traefik.
#
# Optional
# Default: true
#
exposedByDefault = false
# Enable docker TLS connection.
#
# Optional
#
# [docker.tls]
# ca = "/etc/ssl/ca.crt"
# cert = "/etc/ssl/docker.crt"
# key = "/etc/ssl/docker.key"
# insecureSkipVerify = true
To enable constraints see provider-specific constraints section.
Security Considerations
Security Challenge with the Docker Socket
Traefik requires access to the docker socket to get its dynamic configuration, by watching the Docker API through this socket.
!!! important Depending on your context and your usage, accessing the Docker API without any restriction might be a security concern.
As explained on the Docker documentation: (Docker Daemon Attack Surface page):
[...] only **trusted** users should be allowed to control your Docker daemon [...]
If the Traefik processes (handling requests from the outside world) is attacked, then the attacker can access the Docker (or Swarm Mode) backend.
Also, when using Swarm Mode, it is mandatory to schedule Traefik's containers on the Swarm manager nodes, to let Traefik accessing the Docker Socket of the Swarm manager node.
More information about Docker's security:
- KubeCon EU 2018 Keynote, Running with Scissors, from Liz Rice
- Don't expose the Docker socket (not even to a container)
- A thread on Stack Overflow about sharing the
/var/run/docker.sock
file - To Dind or not to DinD
Security Compensation
The main security compensation is to expose the Docker socket over TCP, instead of the default Unix socket file. It allows different implementation levels of the AAA (Authentication, Authorization, Accounting) concepts, depending on your security assessment:
-
Authentication with Client Certificates as described in the "Protect the Docker daemon socket" page of Docker's documentation
-
Authorization with the Docker Authorization Plugin Mechanism
-
Accounting at networking level, by exposing the socket only inside a Docker private network, only available for Traefik.
-
Accounting at container level, by exposing the socket on a another container than Traefik's. With Swarm mode, it allows scheduling of Traefik on worker nodes, with only the "socket exposer" container on the manager nodes.
-
Accounting at kernel level, by enforcing kernel calls with mechanisms like SELinux, to only allows an identified set of actions for Traefik's process (or the "socket exposer" process).
Use the following ressources to get started:
- Traefik issue GH-4174 about security with Docker socket
- Inspecting Docker Activity with Socat
- Letting Traefik run on Worker Nodes
- Docker Socket Proxy from Tecnativa
Labels: overriding default behavior
Using Docker with Swarm Mode
If you use a compose file with the Swarm mode, labels should be defined in the deploy
part of your service.
This behavior is only enabled for docker-compose version 3+ (Compose file reference).
version: "3"
services:
whoami:
deploy:
labels:
traefik.docker.network: traefik
Using Docker Compose
If you are intending to use only Docker Compose commands (e.g. docker-compose up --scale whoami=2 -d
), labels should be under your service, otherwise they will be ignored.
version: "3"
services:
whoami:
labels:
traefik.docker.network: traefik
On Containers
Labels can be used on containers to override default behavior.
Label | Description |
---|---|
traefik.docker.network |
Overrides the default docker network to use for connections to the container. [1] |
traefik.domain |
Sets the default base domain for the frontend rules. For more information, check the Container Labels section's of the user guide "Let's Encrypt & Docker" |
traefik.enable=false |
Disables this container in Traefik. |
traefik.port=80 |
Registers this port. Useful when the container exposes multiples ports. |
traefik.tags=foo,bar,myTag |
Adds Traefik tags to the Docker container/service to be used in constraints. |
traefik.protocol=https |
Overrides the default http protocol |
traefik.weight=10 |
Assigns this weight to the container |
traefik.backend=foo |
Overrides the container name by foo in the generated name of the backend. |
traefik.backend.buffering.maxRequestBodyBytes=0 |
See buffering section. |
traefik.backend.buffering.maxResponseBodyBytes=0 |
See buffering section. |
traefik.backend.buffering.memRequestBodyBytes=0 |
See buffering section. |
traefik.backend.buffering.memResponseBodyBytes=0 |
See buffering section. |
traefik.backend.buffering.retryExpression=EXPR |
See buffering section. |
traefik.backend.circuitbreaker.expression=EXPR |
Creates a circuit breaker to be used against the backend |
traefik.backend.responseForwarding.flushInterval=10ms |
Defines the interval between two flushes when forwarding response from backend to client. |
traefik.backend.healthcheck.path=/health |
Enables health check for the backend, hitting the container at path . |
traefik.backend.healthcheck.interval=5s |
Defines the health check interval. |
traefik.backend.healthcheck.timeout=3s |
Defines the health check request timeout. |
traefik.backend.healthcheck.port=8080 |
Sets a different port for the health check. |
traefik.backend.healthcheck.scheme=http |
Overrides the server URL scheme. |
traefik.backend.healthcheck.hostname=foobar.com |
Defines the health check hostname. |
traefik.backend.healthcheck.headers=EXPR |
Defines the health check request headers Format: HEADER:value||HEADER2:value2 |
traefik.backend.loadbalancer.method=drr |
Overrides the default wrr load balancer algorithm |
traefik.backend.loadbalancer.stickiness=true |
Enables backend sticky sessions |
traefik.backend.loadbalancer.stickiness.cookieName=NAME |
Sets the cookie name manually for sticky sessions |
traefik.backend.loadbalancer.swarm=true |
Uses Swarm's inbuilt load balancer (only relevant under Swarm Mode). [3]. |
traefik.backend.maxconn.amount=10 |
Sets a maximum number of connections to the backend. Must be used in conjunction with the below label to take effect. |
traefik.backend.maxconn.extractorfunc=client.ip |
Sets the function to be used against the request to determine what to limit maximum connections to the backend by. Must be used in conjunction with the above label to take effect. |
traefik.frontend.auth.basic=EXPR |
Sets the basic authentication to this frontend in CSV format: User:Hash,User:Hash [2] (DEPRECATED). |
traefik.frontend.auth.basic.realm=REALM |
Sets the realm of basic authentication to this frontend. |
traefik.frontend.auth.basic.removeHeader=true |
If set to true , removes the Authorization header. |
traefik.frontend.auth.basic.users=EXPR |
Sets the basic authentication to this frontend in CSV format: User:Hash,User:Hash [2]. |
traefik.frontend.auth.basic.usersFile=/path/.htpasswd |
Sets the basic authentication with an external file; if users and usersFile are provided, both are merged, with external file contents having precedence. |
traefik.frontend.auth.digest.removeHeader=true |
If set to true , removes the Authorization header. |
traefik.frontend.auth.digest.users=EXPR |
Sets the digest authentication to this frontend in CSV format: User:Realm:Hash,User:Realm:Hash . |
traefik.frontend.auth.digest.usersFile=/path/.htdigest |
Sets the digest authentication with an external file; if users and usersFile are provided, both are merged, with external file contents having precedence. |
traefik.frontend.auth.forward.address=https://example.com |
Sets the URL of the authentication server. |
traefik.frontend.auth.forward.authResponseHeaders=EXPR |
Sets the forward authentication authResponseHeaders in CSV format: X-Auth-User,X-Auth-Header |
traefik.frontend.auth.forward.tls.ca=/path/ca.pem |
Sets the Certificate Authority (CA) for the TLS connection with the authentication server. |
traefik.frontend.auth.forward.tls.caOptional=true |
Checks the certificates if present but do not force to be signed by a specified Certificate Authority (CA). |
traefik.frontend.auth.forward.tls.cert=/path/server.pem |
Sets the Certificate for the TLS connection with the authentication server. |
traefik.frontend.auth.forward.tls.insecureSkipVerify=true |
If set to true invalid SSL certificates are accepted. |
traefik.frontend.auth.forward.tls.key=/path/server.key |
Sets the Certificate for the TLS connection with the authentication server. |
traefik.frontend.auth.forward.trustForwardHeader=true |
Trusts X-Forwarded-* headers. |
traefik.frontend.auth.headerField=X-WebAuth-User |
Sets the header user to pass the authenticated user to the application. |
traefik.frontend.entryPoints=http,https |
Assigns this frontend to entry points http and https .Overrides defaultEntryPoints |
traefik.frontend.errors.<name>.backend=NAME |
See custom error pages section. |
traefik.frontend.errors.<name>.query=PATH |
See custom error pages section. |
traefik.frontend.errors.<name>.status=RANGE |
See custom error pages section. |
traefik.frontend.passHostHeader=true |
Forwards client Host header to the backend. |
traefik.frontend.passTLSClientCert.infos.issuer.commonName=true |
Add the issuer.commonName field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.country=true |
Add the issuer.country field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.domainComponent=true |
Add the issuer.domainComponent field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.locality=true |
Add the issuer.locality field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.organization=true |
Add the issuer.organization field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.province=true |
Add the issuer.province field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.issuer.serialNumber=true |
Add the issuer.serialNumber field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.notAfter=true |
Add the noAfter field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.notBefore=true |
Add the noBefore field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.sans=true |
Add the sans field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.commonName=true |
Add the subject.commonName field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.country=true |
Add the subject.country field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.domainComponent=true |
Add the subject.domainComponent field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.locality=true |
Add the subject.locality field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.organization=true |
Add the subject.organization field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.province=true |
Add the subject.province field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.infos.subject.serialNumber=true |
Add the subject.serialNumber field in a escaped client infos in the X-Forwarded-Ssl-Client-Cert-Infos header. |
traefik.frontend.passTLSClientCert.pem=true |
Pass the escaped pem in the X-Forwarded-Ssl-Client-Cert header. |
traefik.frontend.passTLSCert=true |
Forwards TLS Client certificates to the backend (DEPRECATED). |
traefik.frontend.priority=10 |
Overrides default frontend priority |
traefik.frontend.rateLimit.extractorFunc=EXP |
See rate limiting section. |
traefik.frontend.rateLimit.rateSet.<name>.period=6 |
See rate limiting section. |
traefik.frontend.rateLimit.rateSet.<name>.average=6 |
See rate limiting section. |
traefik.frontend.rateLimit.rateSet.<name>.burst=6 |
See rate limiting section. |
traefik.frontend.redirect.entryPoint=https |
Enables Redirect to another entryPoint to this frontend (e.g. HTTPS) |
traefik.frontend.redirect.regex=^http://localhost/(.*) |
Redirects to another URL to this frontend. Must be set with traefik.frontend.redirect.replacement . |
traefik.frontend.redirect.replacement=http://mydomain/$1 |
Redirects to another URL to this frontend. Must be set with traefik.frontend.redirect.regex . |
traefik.frontend.redirect.permanent=true |
Returns 301 instead of 302. |
traefik.frontend.rule=EXPR |
Overrides the default frontend rule. Default: Host:{containerName}.{domain} or Host:{service}.{project_name}.{domain} if you are using docker-compose . |
traefik.frontend.whiteList.sourceRange=RANGE |
Sets a list of IP-Ranges which are allowed to access. An unset or empty list allows all Source-IPs to access. If one of the Net-Specifications are invalid, the whole list is invalid and allows all Source-IPs to access. |
traefik.frontend.whiteList.ipStrategy=true |
Uses the default IPStrategy. Can be used when there is an existing clientIPStrategy but you want the remote address for whitelisting. |
traefik.frontend.whiteList.ipStrategy.depth=5 |
See whitelist |
traefik.frontend.whiteList.ipStrategy.excludedIPs=127.0.0.1 |
See whitelist |
[1] traefik.docker.network
:
If a container is linked to several networks, be sure to set the proper network name (you can check with docker inspect <container_id>
) otherwise it will randomly pick one (depending on how docker is returning them).
For instance when deploying docker stack
from compose files, the compose defined networks will be prefixed with the stack
name.
Or if your service references external network use it's name instead.
[2] traefik.frontend.auth.basic.users=EXPR
:
To create user:password
pair, it's possible to use this command:
echo $(htpasswd -nb user password) | sed -e s/\\$/\\$\\$/g
.
The result will be user:$$apr1$$9Cv/OMGj$$ZomWQzuQbL.3TRCS81A1g/
, note additional symbol $
makes escaping.
[3] traefik.backend.loadbalancer.swarm
:
If you enable this option, Traefik will use the virtual IP provided by docker swarm instead of the containers IPs.
Which means that Traefik will not perform any kind of load balancing and will delegate this task to swarm.
It also means that Traefik will manipulate only one backend, not one backend per container.
Custom Headers
Label | Description |
---|---|
traefik.frontend.headers.customRequestHeaders=EXPR |
Provides the container with custom request headers that will be appended to each request forwarded to the container. Format: HEADER:value||HEADER2:value2 |
traefik.frontend.headers.customResponseHeaders=EXPR |
Appends the headers to each response returned by the container, before forwarding the response to the client. Format: HEADER:value||HEADER2:value2 |
Security Headers
Label | Description |
---|---|
traefik.frontend.headers.allowedHosts=EXPR |
Provides a list of allowed hosts that requests will be processed. Format: Host1,Host2 |
traefik.frontend.headers.browserXSSFilter=true |
Adds the X-XSS-Protection header with the value 1; mode=block . |
traefik.frontend.headers.contentSecurityPolicy=VALUE |
Adds CSP Header with the custom value. |
traefik.frontend.headers.contentTypeNosniff=true |
Adds the X-Content-Type-Options header with the value nosniff . |
traefik.frontend.headers.customBrowserXSSValue=VALUE |
Set custom value for X-XSS-Protection header. This overrides the BrowserXssFilter option. |
traefik.frontend.headers.customFrameOptionsValue=VALUE |
Overrides the X-Frame-Options header with the custom value. |
traefik.frontend.headers.forceSTSHeader=false |
Adds the STS header to non-SSL requests. |
traefik.frontend.headers.frameDeny=false |
Adds the X-Frame-Options header with the value of DENY . |
traefik.frontend.headers.hostsProxyHeaders=EXPR |
Provides a list of headers that the proxied hostname may be stored. Format: HEADER1,HEADER2 |
traefik.frontend.headers.isDevelopment=false |
This will cause the AllowedHosts , SSLRedirect , and STSSeconds /STSIncludeSubdomains options to be ignored during development.When deploying to production, be sure to set this to false. |
traefik.frontend.headers.publicKey=VALUE |
Adds HPKP header. |
traefik.frontend.headers.referrerPolicy=VALUE |
Adds referrer policy header. |
traefik.frontend.headers.SSLRedirect=true |
Forces the frontend to redirect to SSL if a non-SSL request is sent. |
traefik.frontend.headers.SSLTemporaryRedirect=true |
Forces the frontend to redirect to SSL if a non-SSL request is sent, but by sending a 302 instead of a 301. |
traefik.frontend.headers.SSLHost=HOST |
This setting configures the hostname that redirects will be based on. Default is "", which is the same host as the request. |
traefik.frontend.headers.SSLForceHost=true |
If SSLForceHost is true and SSLHost is set, requests will be forced to use SSLHost even the ones that are already using SSL. Default is false. |
traefik.frontend.headers.SSLProxyHeaders=EXPR |
Header combinations that would signify a proper SSL Request (Such as X-Forwarded-For:https ).Format: HEADER:value||HEADER2:value2 |
traefik.frontend.headers.STSSeconds=315360000 |
Sets the max-age of the STS header. |
traefik.frontend.headers.STSIncludeSubdomains=true |
Adds the IncludeSubdomains section of the STS header. |
traefik.frontend.headers.STSPreload=true |
Adds the preload flag to the STS header. |
On containers with Multiple Ports (segment labels)
Segment labels are used to define routes to a container exposing multiple ports. A segment is a group of labels that apply to a port exposed by a container. You can define as many segments as ports exposed in a container.
Segment labels override the default behavior.
Label | Description |
---|---|
traefik.<segment_name>.backend=BACKEND |
Same as traefik.backend |
traefik.<segment_name>.domain=DOMAIN |
Same as traefik.domain |
traefik.<segment_name>.port=PORT |
Same as traefik.port |
traefik.<segment_name>.protocol=http |
Same as traefik.protocol |
traefik.<segment_name>.weight=10 |
Same as traefik.weight |
traefik.<segment_name>.frontend.auth.basic=EXPR |
Same as traefik.frontend.auth.basic |
traefik.<segment_name>.frontend.auth.basic.removeHeader=true |
Same as traefik.frontend.auth.basic.removeHeader |
traefik.<segment_name>.frontend.auth.basic.users=EXPR |
Same as traefik.frontend.auth.basic.users |
traefik.<segment_name>.frontend.auth.basic.usersFile=/path/.htpasswd |
Same as traefik.frontend.auth.basic.usersFile |
traefik.<segment_name>.frontend.auth.digest.removeHeader=true |
Same as traefik.frontend.auth.digest.removeHeader |
traefik.<segment_name>.frontend.auth.digest.users=EXPR |
Same as traefik.frontend.auth.digest.users |
traefik.<segment_name>.frontend.auth.digest.usersFile=/path/.htdigest |
Same as traefik.frontend.auth.digest.usersFile |
traefik.<segment_name>.frontend.auth.forward.address=https://example.com |
Same as traefik.frontend.auth.forward.address |
traefik.<segment_name>.frontend.auth.forward.authResponseHeaders=EXPR |
Same as traefik.frontend.auth.forward.authResponseHeaders |
traefik.<segment_name>.frontend.auth.forward.tls.ca=/path/ca.pem |
Same as traefik.frontend.auth.forward.tls.ca |
traefik.<segment_name>.frontend.auth.forward.tls.caOptional=true |
Same as traefik.frontend.auth.forward.tls.caOptional |
traefik.<segment_name>.frontend.auth.forward.tls.cert=/path/server.pem |
Same as traefik.frontend.auth.forward.tls.cert |
traefik.<segment_name>.frontend.auth.forward.tls.insecureSkipVerify=true |
Same as traefik.frontend.auth.forward.tls.insecureSkipVerify |
traefik.<segment_name>.frontend.auth.forward.tls.key=/path/server.key |
Same as traefik.frontend.auth.forward.tls.key |
traefik.<segment_name>.frontend.auth.forward.trustForwardHeader=true |
Same as traefik.frontend.auth.forward.trustForwardHeader |
traefik.<segment_name>.frontend.auth.headerField=X-WebAuth-User |
Same as traefik.frontend.auth.headerField |
traefik.<segment_name>.frontend.entryPoints=https |
Same as traefik.frontend.entryPoints |
traefik.<segment_name>.frontend.errors.<name>.backend=NAME |
Same as traefik.frontend.errors.<name>.backend |
traefik.<segment_name>.frontend.errors.<name>.query=PATH |
Same as traefik.frontend.errors.<name>.query |
traefik.<segment_name>.frontend.errors.<name>.status=RANGE |
Same as traefik.frontend.errors.<name>.status |
traefik.<segment_name>.frontend.passHostHeader=true |
Same as traefik.frontend.passHostHeader |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.commonName=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.commonName |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.country=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.country |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.domainComponent=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.domainComponent |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.locality=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.locality |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.organization=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.organization |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.province=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.province |
traefik.<segment_name>.frontend.passTLSClientCert.infos.issuer.serialNumber=true |
Same as traefik.frontend.passTLSClientCert.infos.issuer.serialNumber |
traefik.<segment_name>.frontend.passTLSClientCert.infos.notAfter=true |
Same as traefik.frontend.passTLSClientCert.infos.notAfter |
traefik.<segment_name>.frontend.passTLSClientCert.infos.notBefore=true |
Same as traefik.frontend.passTLSClientCert.infos.notBefore |
traefik.<segment_name>.frontend.passTLSClientCert.infos.sans=true |
Same as traefik.frontend.passTLSClientCert.infos.sans |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.commonName=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.commonName |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.country=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.country |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.domainComponent=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.domainComponent |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.locality=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.locality |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.organization=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.organization |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.province=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.province |
traefik.<segment_name>.frontend.passTLSClientCert.infos.subject.serialNumber=true |
Same as traefik.frontend.passTLSClientCert.infos.subject.serialNumber |
traefik.<segment_name>.frontend.passTLSClientCert.pem=true |
Same as traefik.frontend.passTLSClientCert.infos.pem |
traefik.<segment_name>.frontend.passTLSCert=true |
Same as traefik.frontend.passTLSCert |
traefik.<segment_name>.frontend.priority=10 |
Same as traefik.frontend.priority |
traefik.<segment_name>.frontend.rateLimit.extractorFunc=EXP |
Same as traefik.frontend.rateLimit.extractorFunc |
traefik.<segment_name>.frontend.rateLimit.rateSet.<name>.period=6 |
Same as traefik.frontend.rateLimit.rateSet.<name>.period |
traefik.<segment_name>.frontend.rateLimit.rateSet.<name>.average=6 |
Same as traefik.frontend.rateLimit.rateSet.<name>.average |
traefik.<segment_name>.frontend.rateLimit.rateSet.<name>.burst=6 |
Same as traefik.frontend.rateLimit.rateSet.<name>.burst |
traefik.<segment_name>.frontend.redirect.entryPoint=https |
Same as traefik.frontend.redirect.entryPoint |
traefik.<segment_name>.frontend.redirect.regex=^http://localhost/(.*) |
Same as traefik.frontend.redirect.regex |
traefik.<segment_name>.frontend.redirect.replacement=http://mydomain/$1 |
Same as traefik.frontend.redirect.replacement |
traefik.<segment_name>.frontend.redirect.permanent=true |
Same as traefik.frontend.redirect.permanent |
traefik.<segment_name>.frontend.rule=EXP |
Same as traefik.frontend.rule |
traefik.<segment_name>.frontend.whiteList.sourceRange=RANGE |
Same as traefik.frontend.whiteList.sourceRange |
traefik.<segment_name>.frontend.whiteList.ipStrategy=true |
Same as traefik.frontend.whiteList.ipStrategy |
traefik.<segment_name>.frontend.whiteList.ipStrategy.depth=5 |
Same as traefik.frontend.whiteList.ipStrategy.depth |
traefik.<segment_name>.frontend.whiteList.ipStrategy.excludedIPs=127.0.0.1 |
Same as traefik.frontend.whiteList.ipStrategy.excludedIPs |
Custom Headers
Label | Description |
---|---|
traefik.<segment_name>.frontend.headers.customRequestHeaders=EXPR |
Same as traefik.frontend.headers.customRequestHeaders |
traefik.<segment_name>.frontend.headers.customResponseHeaders=EXPR |
Same as traefik.frontend.headers.customResponseHeaders |
Security Headers
Label | Description |
---|---|
traefik.<segment_name>.frontend.headers.allowedHosts=EXPR |
Same as traefik.frontend.headers.allowedHosts |
traefik.<segment_name>.frontend.headers.browserXSSFilter=true |
Same as traefik.frontend.headers.browserXSSFilter |
traefik.<segment_name>.frontend.headers.contentSecurityPolicy=VALUE |
Same as traefik.frontend.headers.contentSecurityPolicy |
traefik.<segment_name>.frontend.headers.contentTypeNosniff=true |
Same as traefik.frontend.headers.contentTypeNosniff |
traefik.<segment_name>.frontend.headers.customBrowserXSSValue=VALUE |
Same as traefik.frontend.headers.customBrowserXSSValue |
traefik.<segment_name>.frontend.headers.customFrameOptionsValue=VALUE |
Same as traefik.frontend.headers.customFrameOptionsValue |
traefik.<segment_name>.frontend.headers.forceSTSHeader=false |
Same as traefik.frontend.headers.forceSTSHeader |
traefik.<segment_name>.frontend.headers.frameDeny=false |
Same as traefik.frontend.headers.frameDeny |
traefik.<segment_name>.frontend.headers.hostsProxyHeaders=EXPR |
Same as traefik.frontend.headers.hostsProxyHeaders |
traefik.<segment_name>.frontend.headers.isDevelopment=false |
Same as traefik.frontend.headers.isDevelopment |
traefik.<segment_name>.frontend.headers.publicKey=VALUE |
Same as traefik.frontend.headers.publicKey |
traefik.<segment_name>.frontend.headers.referrerPolicy=VALUE |
Same as traefik.frontend.headers.referrerPolicy |
traefik.<segment_name>.frontend.headers.SSLRedirect=true |
Same as traefik.frontend.headers.SSLRedirect |
traefik.<segment_name>.frontend.headers.SSLTemporaryRedirect=true |
Same as traefik.frontend.headers.SSLTemporaryRedirect |
traefik.<segment_name>.frontend.headers.SSLHost=HOST |
Same as traefik.frontend.headers.SSLHost |
traefik.<segment_name>.frontend.headers.SSLForceHost=true |
Same as traefik.frontend.headers.SSLForceHost |
traefik.<segment_name>.frontend.headers.SSLProxyHeaders=EXPR |
Same as traefik.frontend.headers.SSLProxyHeaders=EXPR |
traefik.<segment_name>.frontend.headers.STSSeconds=315360000 |
Same as traefik.frontend.headers.STSSeconds=315360000 |
traefik.<segment_name>.frontend.headers.STSIncludeSubdomains=true |
Same as traefik.frontend.headers.STSIncludeSubdomains=true |
traefik.<segment_name>.frontend.headers.STSPreload=true |
Same as traefik.frontend.headers.STSPreload=true |
!!! note
If a label is defined both as a container label
and a segment label
(for example traefik.<segment_name>.port=PORT
and traefik.port=PORT
), the segment label
is used to defined the <segment_name>
property (port
in the example).
It's possible to mix `container labels` and `segment labels`, in this case `container labels` are used as default value for missing `segment labels` but no frontends are going to be created with the `container labels`.
More details in this [example](/user-guide/docker-and-lets-encrypt/#labels).
!!! warning When running inside a container, Traefik will need network access through:
`docker network connect <network> <traefik-container>`
usebindportip
The default behavior of Traefik is to route requests to the IP/Port of the matching container.
When setting usebindportip
to true, you tell Traefik to use the IP/Port attached to the container's binding instead of the inner network IP/Port.
When used in conjunction with the traefik.port
label (that tells Traefik to route requests to a specific port), Traefik tries to find a binding with traefik.port
port to select the container. If it can't find such a binding, Traefik falls back on the internal network IP of the container, but still uses the traefik.port
that is set in the label.
Below is a recap of the behavior of usebindportip
in different situations.
traefik.port label | Container's binding | Routes to |
---|---|---|
- | - | IntIP:IntPort |
- | ExtPort:IntPort | IntIP:IntPort |
- | ExtIp:ExtPort:IntPort | ExtIp:ExtPort |
LblPort | - | IntIp:LblPort |
LblPort | ExtIp:ExtPort:LblPort | ExtIp:ExtPort |
LblPort | ExtIp:ExtPort:OtherPort | IntIp:LblPort |
LblPort | ExtIp1:ExtPort1:IntPort1 & ExtIp2:LblPort:IntPort2 | ExtIp2:LblPort |
!!! note In the above table, ExtIp stands for "external IP found in the binding", IntIp stands for "internal network container's IP", ExtPort stands for "external Port found in the binding", and IntPort stands for "internal network container's port."