2022-04-15 13:44:08 +00:00
---
title: "Traefik Docker Routing Documentation"
description: "This guide will teach you how to attach labels to your containers, to route traffic and load balance with Traefik and Docker."
---
2019-09-23 12:32:04 +00:00
# Traefik & Docker
A Story of Labels & Containers
{: .subtitle }
![Docker ](../../assets/img/providers/docker.png )
Attach labels to your containers and let Traefik do the rest!
2024-07-11 12:40:07 +00:00
One of the best feature of Traefik is to delegate the routing configuration to the application level.
With Docker, Traefik can leverage labels attached to a container to generate routing rules.
!!! warning "Labels & sensitive data"
We recommend to *not* use labels to store sensitive data (certificates, credentials, etc).
Instead, we recommend to store sensitive data in a safer storage (secrets, file, etc).
2019-09-23 12:32:04 +00:00
## Configuration Examples
2024-07-29 13:39:06 +00:00
??? example "Configuring Docker & Deploying / Exposing one Service"
2019-09-23 12:32:04 +00:00
Enabling the docker provider
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml tab="File (YAML)"
providers:
docker: {}
```
2019-10-28 14:50:06 +00:00
2021-06-18 22:08:08 +00:00
```toml tab="File (TOML)"
[providers.docker]
```
2019-09-23 12:32:04 +00:00
```bash tab="CLI"
--providers.docker=true
```
Attaching labels to containers (in your docker compose file)
```yaml
version: "3"
services:
my-container:
# ...
labels:
2020-03-13 21:50:05 +00:00
- traefik.http.routers.my-container.rule=Host(`example.com`)
2019-09-23 12:32:04 +00:00
```
2019-10-28 14:50:06 +00:00
??? example "Specify a Custom Port for the Container"
2020-03-13 21:50:05 +00:00
Forward requests for `http://example.com` to `http://<private IP of container>:12345` :
2019-10-28 14:50:06 +00:00
```yaml
version: "3"
services:
my-container:
# ...
labels:
2020-03-13 21:50:05 +00:00
- traefik.http.routers.my-container.rule=Host(`example.com`)
2019-10-28 14:50:06 +00:00
# Tell Traefik to use the port 12345 to connect to `my-container`
- traefik.http.services.my-service.loadbalancer.server.port=12345
```
!!! important "Traefik Connecting to the Wrong Port: `HTTP/502 Gateway Error` "
By default, Traefik uses the first exposed port of a container.
2019-10-28 16:42:05 +00:00
Setting the label `traefik.http.services.xxx.loadbalancer.server.port`
2019-10-28 14:50:06 +00:00
overrides that behavior.
2020-12-03 08:36:03 +00:00
??? example "Specifying more than one router and service per container"
Forwarding requests to more than one port on a container requires referencing the service loadbalancer port definition using the service parameter on the router.
In this example, requests are forwarded for `http://example-a.com` to `http://<private IP of container>:8000` in addition to `http://example-b.com` forwarding to `http://<private IP of container>:9000` :
```yaml
version: "3"
services:
my-container:
# ...
labels:
- traefik.http.routers.www-router.rule=Host(`example-a.com`)
- traefik.http.routers.www-router.service=www-service
- traefik.http.services.www-service.loadbalancer.server.port=8000
- traefik.http.routers.admin-router.rule=Host(`example-b.com`)
- traefik.http.routers.admin-router.service=admin-service
- traefik.http.services.admin-service.loadbalancer.server.port=9000
```
2019-09-23 12:32:04 +00:00
## Routing Configuration
!!! info "Labels"
2019-10-28 14:50:06 +00:00
2024-09-13 09:40:04 +00:00
- Labels are case-insensitive.
2019-09-26 10:48:05 +00:00
- The complete list of labels can be found in [the reference page ](../../reference/dynamic-configuration/docker.md ).
2019-09-23 12:32:04 +00:00
### General
Traefik creates, for each container, a corresponding [service ](../services/index.md ) and [router ](../routers/index.md ).
The Service automatically gets a server per instance of the container,
and the router automatically gets a rule defined by `defaultRule` (if no rule for it was defined in labels).
2019-09-26 10:48:05 +00:00
#### Service definition
--8< -- " content / routing / providers / service-by-label . md "
2024-07-29 13:39:06 +00:00
??? example "Automatic assignment with one Service"
2019-09-26 10:48:05 +00:00
With labels in a compose file
```yaml
labels:
2020-03-13 21:50:05 +00:00
- "traefik.http.routers.myproxy.rule=Host(`example.net`)"
2019-09-26 10:48:05 +00:00
# service myservice gets automatically assigned to router myproxy
- "traefik.http.services.myservice.loadbalancer.server.port=80"
```
2024-07-29 13:39:06 +00:00
??? example "Automatic service creation with one Router"
2019-09-26 10:48:05 +00:00
With labels in a compose file
```yaml
labels:
# no service specified or defined and yet one gets automatically created
# and assigned to router myproxy.
2020-03-13 21:50:05 +00:00
- "traefik.http.routers.myproxy.rule=Host(`example.net`)"
2019-09-26 10:48:05 +00:00
```
2024-07-29 13:39:06 +00:00
??? example "Explicit definition with one Service"
With labels in a compose file
```yaml
labels:
- traefik.http.routers.www-router.rule=Host(`example-a.com`)
# Explicit link between the router and the service
- traefik.http.routers.www-router.service=www-service
- traefik.http.services.www-service.loadbalancer.server.port=8000
```
2019-09-23 12:32:04 +00:00
### Routers
To update the configuration of the Router automatically attached to the container,
add labels starting with `traefik.http.routers.<name-of-your-choice>.` and followed by the option you want to change.
2020-03-13 21:50:05 +00:00
For example, to change the rule, you could add the label ```traefik.http.routers.my-container.rule=Host(`example.com`)```.
2019-09-23 12:32:04 +00:00
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the router name `<router_name>` ."
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.routers.< router_name > .rule`"
2019-10-28 14:50:06 +00:00
See [rule ](../routers/index.md#rule ) for more information.
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.http.routers.myrouter.rule=Host(`example.com`)"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.< router_name > .entrypoints`"
2019-10-28 14:50:06 +00:00
See [entry points ](../routers/index.md#entrypoints ) for more information.
2019-09-23 12:32:04 +00:00
```yaml
2019-11-27 19:08:03 +00:00
- "traefik.http.routers.myrouter.entrypoints=ep1,ep2"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.< router_name > .middlewares`"
2019-10-28 14:50:06 +00:00
See [middlewares ](../routers/index.md#middlewares ) and [middlewares overview ](../../middlewares/overview.md ) for more information.
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.routers.myrouter.middlewares=auth,prefix,cb"
```
??? info "`traefik.http.routers.< router_name > .service`"
2019-10-28 14:50:06 +00:00
2020-01-09 15:34:05 +00:00
See [service ](../routers/index.md#service ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.routers.myrouter.service=myservice"
```
??? info "`traefik.http.routers.< router_name > .tls`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [tls ](../routers/index.md#tls ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2019-09-27 11:08:03 +00:00
- "traefik.http.routers.myrouter.tls=true"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.< router_name > .tls.certresolver`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [certResolver ](../routers/index.md#certresolver ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.routers.myrouter.tls.certresolver=myresolver"
```
??? info "`traefik.http.routers.< router_name > .tls.domains[n].main`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [domains ](../routers/index.md#domains ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.http.routers.myrouter.tls.domains[0].main=example.org"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.< router_name > .tls.domains[n].sans`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [domains ](../routers/index.md#domains ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.http.routers.myrouter.tls.domains[0].sans=test.example.org,dev.example.org"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.< router_name > .tls.options`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [options ](../routers/index.md#options ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.routers.myrouter.tls.options=foobar"
```
??? info "`traefik.http.routers.< router_name > .priority`"
2019-10-28 14:50:06 +00:00
2019-10-28 22:20:03 +00:00
See [priority ](../routers/index.md#priority ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.routers.myrouter.priority=42"
```
### Services
To update the configuration of the Service automatically attached to the container,
add labels starting with `traefik.http.services.<name-of-your-choice>.` , followed by the option you want to change.
For example, to change the `passHostHeader` behavior,
you'd add the label `traefik.http.services.<name-of-your-choice>.loadbalancer.passhostheader=false` .
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the service name `<service_name>` ."
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.server.port`"
2021-06-18 22:08:08 +00:00
2019-09-23 12:32:04 +00:00
Registers a port.
Useful when the container exposes multiples ports.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.server.port=8080"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.server.scheme`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
Overrides the default scheme.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.server.scheme=http"
```
2021-02-01 12:58:03 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.serverstransport`"
2021-03-03 15:48:04 +00:00
Allows to reference a ServersTransport resource that is defined either with the File provider or the Kubernetes CRD one.
2021-02-01 12:58:03 +00:00
See [serverstransport ](../services/index.md#serverstransport ) for more information.
2021-06-18 22:08:08 +00:00
2021-02-01 12:58:03 +00:00
```yaml
2021-03-03 15:48:04 +00:00
- "traefik.http.services.< service_name > .loadbalancer.serverstransport=foobar@file"
2021-02-01 12:58:03 +00:00
```
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.passhostheader`"
2019-10-28 14:50:06 +00:00
2019-09-30 09:26:06 +00:00
See [pass Host header ](../services/index.md#pass-host-header ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.passhostheader=true"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.headers.< header_name > `"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.headers.X-Foo=foobar"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.hostname`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.http.services.myservice.loadbalancer.healthcheck.hostname=example.org"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.interval`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-05-26 19:54:03 +00:00
- "traefik.http.services.myservice.loadbalancer.healthcheck.interval=10s"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.path`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.path=/foo"
```
2022-08-08 13:22:07 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.method`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.method=foobar"
```
2022-11-24 10:40:05 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.status`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.status=42"
```
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.port`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.port=42"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.scheme`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.scheme=http"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.timeout`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [health check ](../services/index.md#health-check ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2022-09-05 15:22:08 +00:00
- "traefik.http.services.myservice.loadbalancer.healthcheck.timeout=10s"
2019-09-23 12:32:04 +00:00
```
2020-02-26 16:28:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.followredirects`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
- "traefik.http.services.myservice.loadbalancer.healthcheck.followredirects=true"
```
2020-04-29 15:10:05 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-04-29 15:10:05 +00:00
- "traefik.http.services.myservice.loadbalancer.sticky.cookie=true"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.httponly`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.httponly=true"
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.name`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.name=foobar"
```
2024-11-06 15:04:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.path`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.path=/foobar"
```
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.secure`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.secure=true"
```
2020-03-23 10:24:05 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.samesite`"
2021-06-18 22:08:08 +00:00
2020-03-23 10:24:05 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
2021-06-18 22:08:08 +00:00
2020-03-23 10:24:05 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.samesite=none"
```
2024-01-18 08:30:06 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.maxage`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
- "traefik.http.services.myservice.loadbalancer.sticky.cookie.maxage=42"
```
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.responseforwarding.flushinterval`"
2019-10-28 14:50:06 +00:00
2019-10-01 11:26:04 +00:00
See [response forwarding ](../services/index.md#response-forwarding ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.http.services.myservice.loadbalancer.responseforwarding.flushinterval=10"
```
### Middleware
You can declare pieces of middleware using labels starting with `traefik.http.middlewares.<name-of-your-choice>.` ,
followed by the middleware type/options.
2021-06-11 13:30:05 +00:00
For example, to declare a middleware [`redirectscheme` ](../../middlewares/http/redirectscheme.md ) named `my-redirect` ,
2019-09-23 12:32:04 +00:00
you'd write `traefik.http.middlewares.my-redirect.redirectscheme.scheme=https` .
More information about available middlewares in the dedicated [middlewares section ](../../middlewares/overview.md ).
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the middleware name."
2019-09-23 12:32:04 +00:00
??? example "Declaring and Referencing a Middleware"
```yaml
services:
my-container:
# ...
labels:
# Declaring a middleware
- traefik.http.middlewares.my-redirect.redirectscheme.scheme=https
# Referencing a middleware
- traefik.http.routers.my-container.middlewares=my-redirect
```
!!! warning "Conflicts in Declaration"
If you declare multiple middleware with the same name but with different parameters, the middleware fails to be declared.
### TCP
You can declare TCP Routers and/or Services using labels.
2024-07-29 13:39:06 +00:00
??? example "Declaring TCP Routers with one Service"
2019-09-23 12:32:04 +00:00
```yaml
services:
my-container:
# ...
labels:
2020-03-13 21:50:05 +00:00
- "traefik.tcp.routers.my-router.rule=HostSNI(`example.com`)"
2019-09-23 12:32:04 +00:00
- "traefik.tcp.routers.my-router.tls=true"
- "traefik.tcp.services.my-service.loadbalancer.server.port=4123"
```
!!! warning "TCP and HTTP"
If you declare a TCP Router/Service, it will prevent Traefik from automatically creating an HTTP Router/Service (like it does by default if no TCP Router/Service is defined).
You can declare both a TCP Router/Service and an HTTP Router/Service for the same container (but you have to do so manually).
#### TCP Routers
??? info "`traefik.tcp.routers.< router_name > .entrypoints`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [entry points ](../routers/index.md#entrypoints_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.entrypoints=ep1,ep2"
```
??? info "`traefik.tcp.routers.< router_name > .rule`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [rule ](../routers/index.md#rule_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.tcp.routers.mytcprouter.rule=HostSNI(`example.com`)"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.tcp.routers.< router_name > .service`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [service ](../routers/index.md#services ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.service=myservice"
```
??? info "`traefik.tcp.routers.< router_name > .tls`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [TLS ](../routers/index.md#tls_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.tls=true"
```
??? info "`traefik.tcp.routers.< router_name > .tls.certresolver`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [certResolver ](../routers/index.md#certresolver_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.tls.certresolver=myresolver"
```
??? info "`traefik.tcp.routers.< router_name > .tls.domains[n].main`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [domains ](../routers/index.md#domains_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.tcp.routers.mytcprouter.tls.domains[0].main=example.org"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.tcp.routers.< router_name > .tls.domains[n].sans`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [domains ](../routers/index.md#domains_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2020-03-13 21:50:05 +00:00
- "traefik.tcp.routers.mytcprouter.tls.domains[0].sans=test.example.org,dev.example.org"
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.tcp.routers.< router_name > .tls.options`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [options ](../routers/index.md#options_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.tls.options=mysoptions"
```
??? info "`traefik.tcp.routers.< router_name > .tls.passthrough`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
See [TLS ](../routers/index.md#tls_1 ) for more information.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.routers.mytcprouter.tls.passthrough=true"
```
2022-03-17 17:02:08 +00:00
??? info "`traefik.tcp.routers.< router_name > .priority`"
See [priority ](../routers/index.md#priority_1 ) for more information.
```yaml
- "traefik.tcp.routers.myrouter.priority=42"
```
2019-09-23 12:32:04 +00:00
#### TCP Services
??? info "`traefik.tcp.services.< service_name > .loadbalancer.server.port`"
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
Registers a port of the application.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
- "traefik.tcp.services.mytcpservice.loadbalancer.server.port=423"
```
2022-12-09 08:58:05 +00:00
??? info "`traefik.tcp.services.< service_name > .loadbalancer.server.tls`"
2019-10-28 14:50:06 +00:00
2022-12-09 08:58:05 +00:00
Determines whether to use TLS when dialing with the backend.
2019-10-28 14:50:06 +00:00
2019-09-23 12:32:04 +00:00
```yaml
2022-12-09 08:58:05 +00:00
- "traefik.tcp.services.mytcpservice.loadbalancer.server.tls=true"
2019-09-23 12:32:04 +00:00
```
2020-11-17 12:04:04 +00:00
??? info "`traefik.tcp.services.< service_name > .loadbalancer.proxyprotocol.version`"
See [PROXY protocol ](../services/index.md#proxy-protocol ) for more information.
```yaml
- "traefik.tcp.services.mytcpservice.loadbalancer.proxyprotocol.version=1"
```
2022-12-09 08:58:05 +00:00
??? info "`traefik.tcp.services.< service_name > .loadbalancer.serverstransport`"
Allows to reference a ServersTransport resource that is defined either with the File provider or the Kubernetes CRD one.
See [serverstransport ](../services/index.md#serverstransport_2 ) for more information.
```yaml
- "traefik.tcp.services.< service_name > .loadbalancer.serverstransport=foobar@file"
```
2020-02-20 21:24:05 +00:00
### UDP
You can declare UDP Routers and/or Services using labels.
2024-07-29 13:39:06 +00:00
??? example "Declaring UDP Routers with one Service"
2020-02-20 21:24:05 +00:00
```yaml
services:
my-container:
# ...
labels:
2020-07-27 23:02:03 +00:00
- "traefik.udp.routers.my-router.entrypoints=udp"
2020-02-20 21:24:05 +00:00
- "traefik.udp.services.my-service.loadbalancer.server.port=4123"
```
!!! warning "UDP and HTTP"
If you declare a UDP Router/Service, it will prevent Traefik from automatically creating an HTTP Router/Service (like it does by default if no UDP Router/Service is defined).
You can declare both a UDP Router/Service and an HTTP Router/Service for the same container (but you have to do so manually).
#### UDP Routers
??? info "`traefik.udp.routers.< router_name > .entrypoints`"
See [entry points ](../routers/index.md#entrypoints_2 ) for more information.
```yaml
- "traefik.udp.routers.myudprouter.entrypoints=ep1,ep2"
```
??? info "`traefik.udp.routers.< router_name > .service`"
See [service ](../routers/index.md#services_1 ) for more information.
```yaml
- "traefik.udp.routers.myudprouter.service=myservice"
```
#### UDP Services
??? info "`traefik.udp.services.< service_name > .loadbalancer.server.port`"
Registers a port of the application.
```yaml
- "traefik.udp.services.myudpservice.loadbalancer.server.port=423"
```
2019-09-23 12:32:04 +00:00
### Specific Provider Options
#### `traefik.enable`
```yaml
- "traefik.enable=true"
```
You can tell Traefik to consider (or not) the container by setting `traefik.enable` to true or false.
This option overrides the value of `exposedByDefault` .
#### `traefik.docker.network`
```yaml
- "traefik.docker.network=mynetwork"
```
Overrides the default docker network to use for connections to the container.
If a container is linked to several networks, be sure to set the proper network name (you can check this with `docker inspect <container_id>` ),
otherwise it will randomly pick one (depending on how docker is returning them).
!!! warning
When deploying a stack from a compose file `stack` , the networks defined are prefixed with `stack` .