2019-07-08 09:00:04 +00:00
<!--
CODE GENERATED AUTOMATICALLY
THIS FILE MUST NOT BE EDITED BY HAND
-->
`--accesslog` :
Access log settings. (Default: ```false```)
2024-01-30 15:28:05 +00:00
`--accesslog.addinternals` :
Enables access log for internal services (ping, dashboard, etc...). (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--accesslog.bufferingsize` :
Number of access log lines to process in a buffered way. (Default: ```0```)
`--accesslog.fields.defaultmode` :
Default mode for fields: keep | drop (Default: ```keep```)
`--accesslog.fields.headers.defaultmode` :
Default mode for fields: keep | drop | redact (Default: ```drop```)
`--accesslog.fields.headers.names.<name>` :
Override mode for headers
`--accesslog.fields.names.<name>` :
Override mode for fields
`--accesslog.filepath` :
Access log file path. Stdout is used when omitted or empty.
`--accesslog.filters.minduration` :
Keep access logs when request took longer than the specified duration. (Default: ```0```)
`--accesslog.filters.retryattempts` :
Keep access logs when at least one retry happened. (Default: ```false```)
`--accesslog.filters.statuscodes` :
Keep access logs with status codes in the specified range.
`--accesslog.format` :
Access log format: json | common (Default: ```common```)
2019-07-19 09:52:04 +00:00
`--api` :
Enable api/dashboard. (Default: ```false```)
`--api.dashboard` :
Activate dashboard. (Default: ```true```)
`--api.debug` :
Enable additional endpoints for debugging and profiling. (Default: ```false```)
2023-07-19 14:56:05 +00:00
`--api.disabledashboardad` :
Disable ad in the dashboard. (Default: ```false```)
2019-09-06 13:08:04 +00:00
`--api.insecure` :
2019-08-30 10:16:04 +00:00
Activate API directly on the entryPoint named traefik. (Default: ```false```)
2019-09-06 13:08:04 +00:00
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>` :
Certificates resolvers configuration. (Default: ```false```)
2019-07-08 09:00:04 +00:00
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.caserver` :
2019-07-08 09:00:04 +00:00
CA server to use. (Default: ```https://acme-v02.api.letsencrypt.org/directory```)
2021-11-10 11:06:09 +00:00
`--certificatesresolvers.<name>.acme.certificatesduration` :
Certificates' duration in hours. (Default: ```2160```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.dnschallenge` :
2019-07-08 09:00:04 +00:00
Activate DNS-01 Challenge. (Default: ```false```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.dnschallenge.delaybeforecheck` :
2019-07-08 09:00:04 +00:00
Assume DNS propagates after a delay in seconds rather than finding and querying nameservers. (Default: ```0```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.dnschallenge.disablepropagationcheck` :
2019-07-08 09:00:04 +00:00
Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready. [not recommended] (Default: ```false```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.dnschallenge.provider` :
2019-07-08 09:00:04 +00:00
Use a DNS-01 based challenge provider rather than HTTPS.
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.dnschallenge.resolvers` :
2019-07-08 09:00:04 +00:00
Use following DNS servers to resolve the FQDN authority.
2020-12-01 09:40:05 +00:00
`--certificatesresolvers.<name>.acme.eab.hmacencoded` :
Base64 encoded HMAC key from External CA.
`--certificatesresolvers.<name>.acme.eab.kid` :
Key identifier from External CA.
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.email` :
2019-07-08 09:00:04 +00:00
Email address used for registration.
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.httpchallenge` :
2019-07-08 09:00:04 +00:00
Activate HTTP-01 Challenge. (Default: ```false```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.httpchallenge.entrypoint` :
2019-07-08 09:00:04 +00:00
HTTP challenge EntryPoint
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.keytype` :
2019-07-08 09:00:04 +00:00
KeyType used for generating certificate private key. Allow value 'EC256', 'EC384', 'RSA2048', 'RSA4096', 'RSA8192'. (Default: ```RSA4096```)
2020-09-04 08:52:03 +00:00
`--certificatesresolvers.<name>.acme.preferredchain` :
Preferred chain to use.
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.storage` :
2019-07-08 09:00:04 +00:00
Storage to use. (Default: ```acme.json```)
2019-07-19 09:52:04 +00:00
`--certificatesresolvers.<name>.acme.tlschallenge` :
2019-07-08 09:00:04 +00:00
Activate TLS-ALPN-01 Challenge. (Default: ```true```)
2022-09-30 13:20:08 +00:00
`--certificatesresolvers.<name>.tailscale` :
Enables Tailscale certificate resolution. (Default: ```true```)
2024-01-23 10:34:05 +00:00
`--core.defaultrulesyntax` :
Defines the rule parser default syntax (v2 or v3) (Default: ```v3```)
2019-07-08 09:00:04 +00:00
`--entrypoints.<name>` :
Entry points definition. (Default: ```false```)
`--entrypoints.<name>.address` :
Entry point address.
2022-10-11 07:36:08 +00:00
`--entrypoints.<name>.asdefault` :
Adds this EntryPoint to the list of default EntryPoints to be used on routers that don't have any Entrypoint defined. (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--entrypoints.<name>.forwardedheaders.insecure` :
Trust all forwarded headers. (Default: ```false```)
`--entrypoints.<name>.forwardedheaders.trustedips` :
Trust only forwarded headers from selected IPs.
2020-03-05 11:46:05 +00:00
`--entrypoints.<name>.http` :
HTTP configuration.
2023-06-15 16:20:06 +00:00
`--entrypoints.<name>.http.encodequerysemicolons` :
Defines whether request query semicolons should be URLEncoded. (Default: ```false```)
2020-03-05 11:46:05 +00:00
`--entrypoints.<name>.http.middlewares` :
Default middlewares for the routers linked to the entry point.
2020-03-18 17:12:24 +00:00
`--entrypoints.<name>.http.redirections.entrypoint.permanent` :
2020-04-07 16:38:04 +00:00
Applies a permanent redirection. (Default: ```true```)
2020-03-18 17:12:24 +00:00
`--entrypoints.<name>.http.redirections.entrypoint.priority` :
2021-02-04 10:44:03 +00:00
Priority of the generated router. (Default: ```2147483646```)
2020-03-18 17:12:24 +00:00
2020-03-05 11:46:05 +00:00
`--entrypoints.<name>.http.redirections.entrypoint.scheme` :
2020-04-07 15:16:03 +00:00
Scheme used for the redirection. (Default: ```https```)
2020-03-05 11:46:05 +00:00
`--entrypoints.<name>.http.redirections.entrypoint.to` :
Targeted entry point of the redirection.
`--entrypoints.<name>.http.tls` :
Default TLS configuration for the routers linked to the entry point. (Default: ```false```)
`--entrypoints.<name>.http.tls.certresolver` :
Default certificate resolver for the routers linked to the entry point.
`--entrypoints.<name>.http.tls.domains` :
Default TLS domains for the routers linked to the entry point.
`--entrypoints.<name>.http.tls.domains[n].main` :
Default subject name.
`--entrypoints.<name>.http.tls.domains[n].sans` :
Subject alternative names.
`--entrypoints.<name>.http.tls.options` :
Default TLS options for the routers linked to the entry point.
2022-04-04 09:46:07 +00:00
`--entrypoints.<name>.http2.maxconcurrentstreams` :
Specifies the number of concurrent streams per connection that each client is allowed to initiate. (Default: ```250```)
2021-09-10 12:58:13 +00:00
`--entrypoints.<name>.http3` :
2022-04-04 09:46:07 +00:00
HTTP/3 configuration. (Default: ```false```)
2021-09-10 12:58:13 +00:00
`--entrypoints.<name>.http3.advertisedport` :
UDP port to advertise, on which HTTP/3 is available. (Default: ```0```)
2019-07-08 09:00:04 +00:00
`--entrypoints.<name>.proxyprotocol` :
Proxy-Protocol configuration. (Default: ```false```)
`--entrypoints.<name>.proxyprotocol.insecure` :
Trust all. (Default: ```false```)
`--entrypoints.<name>.proxyprotocol.trustedips` :
Trust only selected IPs.
2024-01-30 13:56:05 +00:00
`--entrypoints.<name>.reuseport` :
Enables EntryPoints from the same or different processes listening on the same TCP/UDP port. (Default: ```false```)
2024-01-02 15:40:06 +00:00
`--entrypoints.<name>.transport.keepalivemaxrequests` :
Maximum number of requests before closing a keep-alive connection. (Default: ```0```)
`--entrypoints.<name>.transport.keepalivemaxtime` :
Maximum duration before closing a keep-alive connection. (Default: ```0```)
2019-07-08 09:00:04 +00:00
`--entrypoints.<name>.transport.lifecycle.gracetimeout` :
Duration to give active requests a chance to finish before Traefik stops. (Default: ```10```)
`--entrypoints.<name>.transport.lifecycle.requestacceptgracetimeout` :
Duration to keep accepting requests before Traefik initiates the graceful shutdown procedure. (Default: ```0```)
`--entrypoints.<name>.transport.respondingtimeouts.idletimeout` :
IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```180```)
`--entrypoints.<name>.transport.respondingtimeouts.readtimeout` :
ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```0```)
`--entrypoints.<name>.transport.respondingtimeouts.writetimeout` :
WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
2021-01-07 16:16:03 +00:00
`--entrypoints.<name>.udp.timeout` :
Timeout defines how long to wait on an idle session before releasing the related resources. (Default: ```3```)
2020-12-15 15:40:05 +00:00
`--experimental.kubernetesgateway` :
Allow the Kubernetes gateway api provider usage. (Default: ```false```)
2021-06-29 15:02:13 +00:00
`--experimental.localplugins.<name>` :
Local plugins configuration. (Default: ```false```)
`--experimental.localplugins.<name>.modulename` :
plugin's module name.
2020-04-20 16:36:34 +00:00
`--experimental.plugins.<name>.modulename` :
plugin's module name.
`--experimental.plugins.<name>.version` :
plugin's version.
2019-07-08 09:00:04 +00:00
`--global.checknewversion` :
2021-02-26 09:20:03 +00:00
Periodically check if a new version has been released. (Default: ```true```)
2019-07-08 09:00:04 +00:00
`--global.sendanonymoususage` :
2024-01-02 17:20:06 +00:00
Periodically send anonymous usage statistics. If the option is not specified, it will be disabled by default. (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--hostresolver` :
Enable CNAME Flattening. (Default: ```false```)
`--hostresolver.cnameflattening` :
A flag to enable/disable CNAME flattening (Default: ```false```)
`--hostresolver.resolvconfig` :
resolv.conf used for DNS resolving (Default: ```/etc/resolv.conf```)
`--hostresolver.resolvdepth` :
The maximal depth of DNS recursive resolving (Default: ```5```)
`--log` :
Traefik log settings. (Default: ```false```)
2022-11-21 17:36:05 +00:00
`--log.compress` :
Determines if the rotated log files should be compressed using gzip. (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--log.filepath` :
Traefik log file path. Stdout is used when omitted or empty.
`--log.format` :
Traefik log format: json | common (Default: ```common```)
`--log.level` :
Log level set to traefik logs. (Default: ```ERROR```)
2022-11-21 17:36:05 +00:00
`--log.maxage` :
Maximum number of days to retain old log files based on the timestamp encoded in their filename. (Default: ```0```)
`--log.maxbackups` :
Maximum number of old log files to retain. (Default: ```0```)
`--log.maxsize` :
Maximum size in megabytes of the log file before it gets rotated. (Default: ```0```)
`--log.nocolor` :
When using the 'common' format, disables the colorized output. (Default: ```false```)
2024-01-30 15:28:05 +00:00
`--metrics.addinternals` :
Enables metrics for internal services (ping, dashboard, etc...). (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--metrics.datadog` :
2019-09-02 10:18:04 +00:00
Datadog metrics exporter type. (Default: ```false```)
2019-07-08 09:00:04 +00:00
2019-07-18 19:36:05 +00:00
`--metrics.datadog.addentrypointslabels` :
Enable metrics on entry points. (Default: ```true```)
2019-07-08 09:00:04 +00:00
`--metrics.datadog.address` :
2019-09-02 10:18:04 +00:00
Datadog's address. (Default: ```localhost:8125```)
2019-07-08 09:00:04 +00:00
2021-04-30 08:22:04 +00:00
`--metrics.datadog.addrouterslabels` :
Enable metrics on routers. (Default: ```false```)
2019-07-18 19:36:05 +00:00
`--metrics.datadog.addserviceslabels` :
Enable metrics on services. (Default: ```true```)
2021-10-06 15:34:07 +00:00
`--metrics.datadog.prefix` :
Prefix to use for metrics collection. (Default: ```traefik```)
2019-07-08 09:00:04 +00:00
`--metrics.datadog.pushinterval` :
2019-09-02 10:18:04 +00:00
Datadog push interval. (Default: ```10```)
2019-07-08 09:00:04 +00:00
2022-02-09 14:32:12 +00:00
`--metrics.influxdb2` :
InfluxDB v2 metrics exporter type. (Default: ```false```)
`--metrics.influxdb2.addentrypointslabels` :
Enable metrics on entry points. (Default: ```true```)
`--metrics.influxdb2.additionallabels.<name>` :
Additional labels (influxdb tags) on all metrics
`--metrics.influxdb2.address` :
InfluxDB v2 address. (Default: ```http://localhost:8086```)
`--metrics.influxdb2.addrouterslabels` :
Enable metrics on routers. (Default: ```false```)
`--metrics.influxdb2.addserviceslabels` :
Enable metrics on services. (Default: ```true```)
`--metrics.influxdb2.bucket` :
InfluxDB v2 bucket ID.
`--metrics.influxdb2.org` :
InfluxDB v2 org ID.
`--metrics.influxdb2.pushinterval` :
InfluxDB v2 push interval. (Default: ```10```)
`--metrics.influxdb2.token` :
InfluxDB v2 access token.
2022-11-29 14:34:05 +00:00
`--metrics.opentelemetry` :
OpenTelemetry metrics exporter type. (Default: ```false```)
`--metrics.opentelemetry.addentrypointslabels` :
Enable metrics on entry points. (Default: ```true```)
`--metrics.opentelemetry.address` :
Address (host:port) of the collector endpoint. (Default: ```localhost:4318```)
`--metrics.opentelemetry.addrouterslabels` :
Enable metrics on routers. (Default: ```false```)
`--metrics.opentelemetry.addserviceslabels` :
Enable metrics on services. (Default: ```true```)
`--metrics.opentelemetry.explicitboundaries` :
Boundaries for latency metrics. (Default: ```0.005000, 0.010000, 0.025000, 0.050000, 0.100000, 0.250000, 0.500000, 1.000000, 2.500000, 5.000000, 10.000000```)
`--metrics.opentelemetry.grpc` :
gRPC specific configuration for the OpenTelemetry collector. (Default: ```true```)
`--metrics.opentelemetry.headers.<name>` :
Headers sent with payload.
`--metrics.opentelemetry.insecure` :
Disables client transport security for the exporter. (Default: ```false```)
`--metrics.opentelemetry.path` :
Set the URL path of the collector endpoint.
`--metrics.opentelemetry.pushinterval` :
Period between calls to collect a checkpoint. (Default: ```10```)
`--metrics.opentelemetry.tls.ca` :
TLS CA
`--metrics.opentelemetry.tls.cert` :
TLS cert
`--metrics.opentelemetry.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--metrics.opentelemetry.tls.key` :
TLS key
2019-07-08 09:00:04 +00:00
`--metrics.prometheus` :
Prometheus metrics exporter type. (Default: ```false```)
2019-07-18 19:36:05 +00:00
`--metrics.prometheus.addentrypointslabels` :
Enable metrics on entry points. (Default: ```true```)
2021-04-30 08:22:04 +00:00
`--metrics.prometheus.addrouterslabels` :
Enable metrics on routers. (Default: ```false```)
2019-07-18 19:36:05 +00:00
`--metrics.prometheus.addserviceslabels` :
Enable metrics on services. (Default: ```true```)
2019-07-08 09:00:04 +00:00
`--metrics.prometheus.buckets` :
Buckets for latency metrics. (Default: ```0.100000, 0.300000, 1.200000, 5.000000```)
2019-09-06 13:08:04 +00:00
`--metrics.prometheus.entrypoint` :
EntryPoint (Default: ```traefik```)
2023-03-20 17:06:07 +00:00
`--metrics.prometheus.headerlabels.<name>` :
Defines the extra labels for the requests_total metrics, and for each of them, the request header containing the value for this label.
2019-11-14 15:40:05 +00:00
`--metrics.prometheus.manualrouting` :
Manual routing (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--metrics.statsd` :
StatsD metrics exporter type. (Default: ```false```)
2019-07-18 19:36:05 +00:00
`--metrics.statsd.addentrypointslabels` :
Enable metrics on entry points. (Default: ```true```)
2019-07-08 09:00:04 +00:00
`--metrics.statsd.address` :
StatsD address. (Default: ```localhost:8125```)
2021-04-30 08:22:04 +00:00
`--metrics.statsd.addrouterslabels` :
Enable metrics on routers. (Default: ```false```)
2019-07-18 19:36:05 +00:00
`--metrics.statsd.addserviceslabels` :
Enable metrics on services. (Default: ```true```)
2019-11-12 17:18:04 +00:00
`--metrics.statsd.prefix` :
Prefix to use for metrics collection. (Default: ```traefik```)
2019-07-08 09:00:04 +00:00
`--metrics.statsd.pushinterval` :
StatsD push interval. (Default: ```10```)
`--ping` :
2019-09-06 13:08:04 +00:00
Enable ping. (Default: ```false```)
`--ping.entrypoint` :
EntryPoint (Default: ```traefik```)
2019-07-08 09:00:04 +00:00
2019-11-14 15:40:05 +00:00
`--ping.manualrouting` :
Manual routing (Default: ```false```)
2020-07-01 12:40:04 +00:00
`--ping.terminatingstatuscode` :
Terminating status code (Default: ```503```)
2019-11-28 20:56:04 +00:00
`--providers.consul` :
Enable Consul backend with default settings. (Default: ```false```)
`--providers.consul.endpoints` :
2022-09-12 15:40:09 +00:00
KV store endpoints. (Default: ```127.0.0.1:8500```)
2019-11-28 20:56:04 +00:00
2022-06-03 10:00:09 +00:00
`--providers.consul.namespaces` :
Sets the namespaces used to discover the configuration (Consul Enterprise only).
2022-01-12 13:42:21 +00:00
2019-11-28 20:56:04 +00:00
`--providers.consul.rootkey` :
2022-09-12 15:40:09 +00:00
Root key used for KV store. (Default: ```traefik```)
2019-11-28 20:56:04 +00:00
`--providers.consul.tls.ca` :
TLS CA
`--providers.consul.tls.cert` :
TLS cert
`--providers.consul.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.consul.tls.key` :
TLS key
2022-01-19 16:46:11 +00:00
`--providers.consul.token` :
2022-09-12 15:40:09 +00:00
Per-request ACL token.
2019-11-28 20:56:04 +00:00
2020-11-18 23:12:03 +00:00
`--providers.consulcatalog` :
Enable ConsulCatalog backend with default settings. (Default: ```false```)
2019-10-31 10:56:05 +00:00
`--providers.consulcatalog.cache` :
Use local agent caching for catalog reads. (Default: ```false```)
2021-07-15 12:02:11 +00:00
`--providers.consulcatalog.connectaware` :
Enable Consul Connect support. (Default: ```false```)
`--providers.consulcatalog.connectbydefault` :
Consider every service as Connect capable by default. (Default: ```false```)
2019-10-15 15:34:08 +00:00
`--providers.consulcatalog.constraints` :
Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container.
`--providers.consulcatalog.defaultrule` :
Default rule. (Default: ```Host(`{{ normalize .Name }}`)```)
`--providers.consulcatalog.endpoint.address` :
2021-07-15 12:02:11 +00:00
The address of the Consul server
2019-10-15 15:34:08 +00:00
`--providers.consulcatalog.endpoint.datacenter` :
Data center to use. If not provided, the default agent data center is used
`--providers.consulcatalog.endpoint.endpointwaittime` :
WaitTime limits how long a Watch will block. If not provided, the agent default values will be used (Default: ```0```)
`--providers.consulcatalog.endpoint.httpauth.password` :
Basic Auth password
`--providers.consulcatalog.endpoint.httpauth.username` :
Basic Auth username
`--providers.consulcatalog.endpoint.scheme` :
The URI scheme for the Consul server
`--providers.consulcatalog.endpoint.tls.ca` :
TLS CA
`--providers.consulcatalog.endpoint.tls.cert` :
TLS cert
`--providers.consulcatalog.endpoint.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.consulcatalog.endpoint.tls.key` :
TLS key
`--providers.consulcatalog.endpoint.token` :
Token is used to provide a per-request ACL token which overrides the agent's default token
`--providers.consulcatalog.exposedbydefault` :
Expose containers by default. (Default: ```true```)
2022-06-03 10:00:09 +00:00
`--providers.consulcatalog.namespaces` :
Sets the namespaces used to discover services (Consul Enterprise only).
2019-10-15 15:34:08 +00:00
`--providers.consulcatalog.prefix` :
2022-06-03 10:00:09 +00:00
Prefix for consul service tags. (Default: ```traefik```)
2019-10-15 15:34:08 +00:00
`--providers.consulcatalog.refreshinterval` :
2022-06-03 10:00:09 +00:00
Interval for check Consul API. (Default: ```15```)
2019-10-15 15:34:08 +00:00
2019-10-31 10:56:05 +00:00
`--providers.consulcatalog.requireconsistent` :
Forces the read to be fully consistent. (Default: ```false```)
2021-07-15 12:02:11 +00:00
`--providers.consulcatalog.servicename` :
Name of the Traefik service in Consul Catalog (needs to be registered via the orchestrator or manually). (Default: ```traefik```)
2019-10-31 10:56:05 +00:00
`--providers.consulcatalog.stale` :
Use stale consistency for catalog reads. (Default: ```false```)
2022-01-28 16:16:07 +00:00
`--providers.consulcatalog.watch` :
Watch Consul API events. (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--providers.docker` :
Enable Docker backend with default settings. (Default: ```false```)
2022-07-06 08:24:08 +00:00
`--providers.docker.allowemptyservices` :
Disregards the Docker containers health checks with respect to the creation or removal of the corresponding services. (Default: ```false```)
2019-07-08 09:00:04 +00:00
`--providers.docker.constraints` :
Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container.
`--providers.docker.defaultrule` :
Default rule. (Default: ```Host(`{{ normalize .Name }}`)```)
`--providers.docker.endpoint` :
2023-05-10 13:28:05 +00:00
Docker server endpoint. Can be a TCP or a Unix socket endpoint. (Default: ```unix:///var/run/docker.sock```)
2019-07-08 09:00:04 +00:00
`--providers.docker.exposedbydefault` :
Expose containers by default. (Default: ```true```)
2020-08-28 08:02:03 +00:00
`--providers.docker.httpclienttimeout` :
2020-09-25 07:14:04 +00:00
Client timeout for HTTP connections. (Default: ```0```)
2020-08-28 08:02:03 +00:00
2019-07-08 09:00:04 +00:00
`--providers.docker.network` :
Default Docker network used.
`--providers.docker.tls.ca` :
TLS CA
`--providers.docker.tls.cert` :
TLS cert
`--providers.docker.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.docker.tls.key` :
TLS key
`--providers.docker.usebindportip` :
Use the ip address from the bound port, rather than from the inner network. (Default: ```false```)
`--providers.docker.watch` :
2022-09-30 08:50:09 +00:00
Watch Docker events. (Default: ```true```)
2019-07-08 09:00:04 +00:00
2020-11-18 23:12:03 +00:00
`--providers.ecs` :
Enable AWS ECS backend with default settings. (Default: ```false```)
2020-07-15 14:28:04 +00:00
`--providers.ecs.accesskeyid` :
2022-09-20 13:42:08 +00:00
AWS credentials access key ID to use for making requests.
2020-07-15 14:28:04 +00:00
`--providers.ecs.autodiscoverclusters` :
2022-09-20 13:42:08 +00:00
Auto discover cluster. (Default: ```false```)
2020-07-15 14:28:04 +00:00
`--providers.ecs.clusters` :
2022-09-20 13:42:08 +00:00
ECS Cluster names. (Default: ```default```)
2020-07-15 14:28:04 +00:00
`--providers.ecs.constraints` :
Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container.
`--providers.ecs.defaultrule` :
Default rule. (Default: ```Host(`{{ normalize .Name }}`)```)
2022-09-14 14:22:08 +00:00
`--providers.ecs.ecsanywhere` :
2022-09-20 13:42:08 +00:00
Enable ECS Anywhere support. (Default: ```false```)
2022-09-14 14:22:08 +00:00
2020-07-15 14:28:04 +00:00
`--providers.ecs.exposedbydefault` :
2022-09-20 13:42:08 +00:00
Expose services by default. (Default: ```true```)
`--providers.ecs.healthytasksonly` :
Determines whether to discover only healthy tasks. (Default: ```false```)
2020-07-15 14:28:04 +00:00
`--providers.ecs.refreshseconds` :
2022-09-20 13:42:08 +00:00
Polling interval (in seconds). (Default: ```15```)
2020-07-15 14:28:04 +00:00
`--providers.ecs.region` :
2022-09-20 13:42:08 +00:00
AWS region to use for requests.
2020-07-15 14:28:04 +00:00
`--providers.ecs.secretaccesskey` :
2022-09-20 13:42:08 +00:00
AWS credentials access key to use for making requests.
2020-07-15 14:28:04 +00:00
2019-11-28 20:56:04 +00:00
`--providers.etcd` :
Enable Etcd backend with default settings. (Default: ```false```)
`--providers.etcd.endpoints` :
2022-09-12 15:40:09 +00:00
KV store endpoints. (Default: ```127.0.0.1:2379```)
2019-11-28 20:56:04 +00:00
`--providers.etcd.password` :
2022-09-12 15:40:09 +00:00
Password for authentication.
2019-11-28 20:56:04 +00:00
`--providers.etcd.rootkey` :
2022-09-12 15:40:09 +00:00
Root key used for KV store. (Default: ```traefik```)
2019-11-28 20:56:04 +00:00
`--providers.etcd.tls.ca` :
TLS CA
`--providers.etcd.tls.cert` :
TLS cert
`--providers.etcd.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.etcd.tls.key` :
TLS key
`--providers.etcd.username` :
2022-09-12 15:40:09 +00:00
Username for authentication.
2019-11-28 20:56:04 +00:00
2019-07-08 09:00:04 +00:00
`--providers.file.debugloggeneratedtemplate` :
Enable debug logging of generated configuration template. (Default: ```false```)
`--providers.file.directory` :
2021-06-18 22:08:08 +00:00
Load dynamic configuration from one or more .yml or .toml files in a directory.
2019-07-08 09:00:04 +00:00
`--providers.file.filename` :
2019-09-26 07:24:04 +00:00
Load dynamic configuration from a file.
2019-07-08 09:00:04 +00:00
`--providers.file.watch` :
Watch provider. (Default: ```true```)
2020-07-15 14:56:03 +00:00
`--providers.http` :
Enable HTTP backend with default settings. (Default: ```false```)
`--providers.http.endpoint` :
Load configuration from this endpoint.
2022-10-14 13:10:10 +00:00
`--providers.http.headers.<name>` :
Define custom headers to be sent to the endpoint.
2020-07-15 14:56:03 +00:00
`--providers.http.pollinterval` :
Polling interval for endpoint. (Default: ```5```)
`--providers.http.polltimeout` :
Polling timeout for endpoint. (Default: ```5```)
`--providers.http.tls.ca` :
TLS CA
`--providers.http.tls.cert` :
TLS cert
`--providers.http.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.http.tls.key` :
TLS key
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd` :
2019-07-08 09:00:04 +00:00
Enable Kubernetes backend with default settings. (Default: ```false```)
2020-12-10 13:58:04 +00:00
`--providers.kubernetescrd.allowcrossnamespace` :
2021-07-13 08:48:05 +00:00
Allow cross namespace resource reference. (Default: ```false```)
2020-12-10 13:58:04 +00:00
2022-03-07 10:08:07 +00:00
`--providers.kubernetescrd.allowemptyservices` :
Allow the creation of services without endpoints. (Default: ```false```)
2021-07-13 10:54:09 +00:00
`--providers.kubernetescrd.allowexternalnameservices` :
Allow ExternalName services. (Default: ```false```)
2020-12-10 13:58:04 +00:00
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.certauthfilepath` :
2019-07-08 09:00:04 +00:00
Kubernetes certificate authority file path (not needed for in-cluster client).
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.endpoint` :
2019-07-08 09:00:04 +00:00
Kubernetes server endpoint (required for external cluster client).
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.ingressclass` :
2019-07-08 09:00:04 +00:00
Value of kubernetes.io/ingress.class annotation to watch for.
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.labelselector` :
Kubernetes label selector to use.
2019-07-08 09:00:04 +00:00
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.namespaces` :
2019-07-08 09:00:04 +00:00
Kubernetes namespaces.
2019-08-30 10:16:04 +00:00
`--providers.kubernetescrd.throttleduration` :
Ingress refresh throttle duration (Default: ```0```)
2019-07-08 19:36:03 +00:00
`--providers.kubernetescrd.token` :
2024-01-11 16:06:06 +00:00
Kubernetes bearer token (not needed for in-cluster client). It accepts either a token value or a file path to the token.
2019-07-08 09:00:04 +00:00
2020-12-15 15:40:05 +00:00
`--providers.kubernetesgateway` :
Enable Kubernetes gateway api provider with default settings. (Default: ```false```)
`--providers.kubernetesgateway.certauthfilepath` :
Kubernetes certificate authority file path (not needed for in-cluster client).
`--providers.kubernetesgateway.endpoint` :
Kubernetes server endpoint (required for external cluster client).
`--providers.kubernetesgateway.labelselector` :
Kubernetes label selector to select specific GatewayClasses.
`--providers.kubernetesgateway.namespaces` :
Kubernetes namespaces.
`--providers.kubernetesgateway.throttleduration` :
Kubernetes refresh throttle duration (Default: ```0```)
`--providers.kubernetesgateway.token` :
2024-01-11 16:06:06 +00:00
Kubernetes bearer token (not needed for in-cluster client). It accepts either a token value or a file path to the token.
2020-12-15 15:40:05 +00:00
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress` :
2019-07-08 09:00:04 +00:00
Enable Kubernetes backend with default settings. (Default: ```false```)
2021-05-06 16:12:10 +00:00
`--providers.kubernetesingress.allowemptyservices` :
Allow creation of services without endpoints. (Default: ```false```)
2021-07-13 10:54:09 +00:00
`--providers.kubernetesingress.allowexternalnameservices` :
Allow ExternalName services. (Default: ```false```)
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.certauthfilepath` :
2019-07-08 09:00:04 +00:00
Kubernetes certificate authority file path (not needed for in-cluster client).
2022-12-22 15:30:05 +00:00
`--providers.kubernetesingress.disableingressclasslookup` :
Disables the lookup of IngressClasses. (Default: ```false```)
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.endpoint` :
2019-07-08 09:00:04 +00:00
Kubernetes server endpoint (required for external cluster client).
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.ingressclass` :
2021-03-02 20:34:03 +00:00
Value of kubernetes.io/ingress.class annotation or IngressClass name to watch for.
2019-07-08 09:00:04 +00:00
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.ingressendpoint.hostname` :
Hostname used for Kubernetes Ingress endpoints.
2019-07-08 09:00:04 +00:00
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.ingressendpoint.ip` :
IP used for Kubernetes Ingress endpoints.
`--providers.kubernetesingress.ingressendpoint.publishedservice` :
Published Kubernetes Service to copy status from.
`--providers.kubernetesingress.labelselector` :
Kubernetes Ingress label selector to use.
`--providers.kubernetesingress.namespaces` :
2019-07-08 09:00:04 +00:00
Kubernetes namespaces.
2019-08-30 10:16:04 +00:00
`--providers.kubernetesingress.throttleduration` :
Ingress refresh throttle duration (Default: ```0```)
2019-07-08 19:36:03 +00:00
`--providers.kubernetesingress.token` :
2024-01-11 16:06:06 +00:00
Kubernetes bearer token (not needed for in-cluster client). It accepts either a token value or a file path to the token.
2019-07-08 09:00:04 +00:00
2022-06-10 16:32:08 +00:00
`--providers.nomad` :
Enable Nomad backend with default settings. (Default: ```false```)
`--providers.nomad.constraints` :
Constraints is an expression that Traefik matches against the Nomad service's tags to determine whether to create route(s) for that service.
`--providers.nomad.defaultrule` :
Default rule. (Default: ```Host(`{{ normalize .Name }}`)```)
`--providers.nomad.endpoint.address` :
2023-03-20 09:44:05 +00:00
The address of the Nomad server, including scheme and port. (Default: ```http://127.0.0.1:4646```)
2022-06-10 16:32:08 +00:00
`--providers.nomad.endpoint.endpointwaittime` :
WaitTime limits how long a Watch will block. If not provided, the agent default values will be used (Default: ```0```)
`--providers.nomad.endpoint.region` :
Nomad region to use. If not provided, the local agent region is used.
`--providers.nomad.endpoint.tls.ca` :
TLS CA
`--providers.nomad.endpoint.tls.cert` :
TLS cert
`--providers.nomad.endpoint.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.nomad.endpoint.tls.key` :
TLS key
`--providers.nomad.endpoint.token` :
Token is used to provide a per-request ACL token.
`--providers.nomad.exposedbydefault` :
Expose Nomad services by default. (Default: ```true```)
2022-09-19 14:26:08 +00:00
`--providers.nomad.namespaces` :
Sets the Nomad namespaces used to discover services.
2022-06-10 16:32:08 +00:00
`--providers.nomad.prefix` :
Prefix for nomad service tags. (Default: ```traefik```)
`--providers.nomad.refreshinterval` :
Interval for polling Nomad API. (Default: ```15```)
`--providers.nomad.stale` :
Use stale consistency for catalog reads. (Default: ```false```)
2021-06-21 09:54:08 +00:00
`--providers.plugin.<name>` :
Plugins configuration.
2019-07-08 09:00:04 +00:00
`--providers.providersthrottleduration` :
2021-02-26 09:20:03 +00:00
Backends throttle duration: minimum duration between 2 events from providers before applying a new configuration. It avoids unnecessary reloads if multiples events are sent in a short amount of time. (Default: ```2```)
2019-07-08 09:00:04 +00:00
2019-11-28 20:56:04 +00:00
`--providers.redis` :
Enable Redis backend with default settings. (Default: ```false```)
2022-09-12 15:40:09 +00:00
`--providers.redis.db` :
Database to be selected after connecting to the server. (Default: ```0```)
2019-11-28 20:56:04 +00:00
`--providers.redis.endpoints` :
2022-09-12 15:40:09 +00:00
KV store endpoints. (Default: ```127.0.0.1:6379```)
2019-11-28 20:56:04 +00:00
`--providers.redis.password` :
2022-09-12 15:40:09 +00:00
Password for authentication.
2019-11-28 20:56:04 +00:00
`--providers.redis.rootkey` :
2022-09-12 15:40:09 +00:00
Root key used for KV store. (Default: ```traefik```)
2019-11-28 20:56:04 +00:00
2024-01-02 15:16:05 +00:00
`--providers.redis.sentinel.latencystrategy` :
Defines whether to route commands to the closest master or replica nodes (mutually exclusive with RandomStrategy and ReplicaStrategy). (Default: ```false```)
`--providers.redis.sentinel.mastername` :
Name of the master.
`--providers.redis.sentinel.password` :
Password for Sentinel authentication.
`--providers.redis.sentinel.randomstrategy` :
Defines whether to route commands randomly to master or replica nodes (mutually exclusive with LatencyStrategy and ReplicaStrategy). (Default: ```false```)
`--providers.redis.sentinel.replicastrategy` :
Defines whether to route all commands to replica nodes (mutually exclusive with LatencyStrategy and RandomStrategy). (Default: ```false```)
`--providers.redis.sentinel.usedisconnectedreplicas` :
Use replicas disconnected with master when cannot get connected replicas. (Default: ```false```)
`--providers.redis.sentinel.username` :
Username for Sentinel authentication.
2019-11-28 20:56:04 +00:00
`--providers.redis.tls.ca` :
TLS CA
`--providers.redis.tls.cert` :
TLS cert
`--providers.redis.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.redis.tls.key` :
TLS key
`--providers.redis.username` :
2022-09-12 15:40:09 +00:00
Username for authentication.
2019-11-28 20:56:04 +00:00
2019-07-08 09:00:04 +00:00
`--providers.rest` :
2019-09-06 13:08:04 +00:00
Enable Rest backend with default settings. (Default: ```false```)
`--providers.rest.insecure` :
2019-08-30 10:16:04 +00:00
Activate REST Provider directly on the entryPoint named traefik. (Default: ```false```)
2019-07-08 09:00:04 +00:00
2023-05-10 13:28:05 +00:00
`--providers.swarm` :
Enable Docker Swarm backend with default settings. (Default: ```false```)
`--providers.swarm.allowemptyservices` :
Disregards the Docker containers health checks with respect to the creation or removal of the corresponding services. (Default: ```false```)
`--providers.swarm.constraints` :
Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container.
`--providers.swarm.defaultrule` :
Default rule. (Default: ```Host(`{{ normalize .Name }}`)```)
`--providers.swarm.endpoint` :
Docker server endpoint. Can be a TCP or a Unix socket endpoint. (Default: ```unix:///var/run/docker.sock```)
`--providers.swarm.exposedbydefault` :
Expose containers by default. (Default: ```true```)
`--providers.swarm.httpclienttimeout` :
Client timeout for HTTP connections. (Default: ```0```)
`--providers.swarm.network` :
Default Docker network used.
`--providers.swarm.refreshseconds` :
Polling interval for swarm mode. (Default: ```15```)
`--providers.swarm.tls.ca` :
TLS CA
`--providers.swarm.tls.cert` :
TLS cert
`--providers.swarm.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
`--providers.swarm.tls.key` :
TLS key
`--providers.swarm.usebindportip` :
Use the ip address from the bound port, rather than from the inner network. (Default: ```false```)
`--providers.swarm.watch` :
Watch Docker events. (Default: ```true```)
2019-11-28 20:56:04 +00:00
`--providers.zookeeper` :
Enable ZooKeeper backend with default settings. (Default: ```false```)
`--providers.zookeeper.endpoints` :
2022-09-12 15:40:09 +00:00
KV store endpoints. (Default: ```127.0.0.1:2181```)
2019-11-28 20:56:04 +00:00
`--providers.zookeeper.password` :
2022-09-12 15:40:09 +00:00
Password for authentication.
2019-11-28 20:56:04 +00:00
`--providers.zookeeper.rootkey` :
2022-09-12 15:40:09 +00:00
Root key used for KV store. (Default: ```traefik```)
2022-01-19 16:46:11 +00:00
2019-11-28 20:56:04 +00:00
`--providers.zookeeper.username` :
2022-09-12 15:40:09 +00:00
Username for authentication.
2019-11-28 20:56:04 +00:00
2019-07-08 09:00:04 +00:00
`--serverstransport.forwardingtimeouts.dialtimeout` :
The amount of time to wait until a connection to a backend server can be established. If zero, no timeout exists. (Default: ```30```)
`--serverstransport.forwardingtimeouts.idleconntimeout` :
The maximum period for which an idle HTTP keep-alive connection will remain open before closing itself (Default: ```90```)
`--serverstransport.forwardingtimeouts.responseheadertimeout` :
The amount of time to wait for a server's response headers after fully writing the request (including its body, if any). If zero, no timeout exists. (Default: ```0```)
`--serverstransport.insecureskipverify` :
Disable SSL certificate verification. (Default: ```false```)
`--serverstransport.maxidleconnsperhost` :
2021-02-26 09:20:03 +00:00
If non-zero, controls the maximum idle (keep-alive) to keep per-host. If zero, DefaultMaxIdleConnsPerHost is used (Default: ```200```)
2019-07-08 09:00:04 +00:00
`--serverstransport.rootcas` :
Add cert file for self-signed certificate.
2022-10-14 15:16:08 +00:00
`--serverstransport.spiffe` :
Defines the SPIFFE configuration. (Default: ```false```)
`--serverstransport.spiffe.ids` :
Defines the allowed SPIFFE IDs (takes precedence over the SPIFFE TrustDomain).
`--serverstransport.spiffe.trustdomain` :
Defines the allowed SPIFFE trust domain.
`--spiffe.workloadapiaddr` :
Defines the workload API address.
2022-12-09 08:58:05 +00:00
`--tcpserverstransport.dialkeepalive` :
Defines the interval between keep-alive probes for an active network connection. If zero, keep-alive probes are sent with a default value (currently 15 seconds), if supported by the protocol and operating system. Network protocols or operating systems that do not support keep-alives ignore this field. If negative, keep-alive probes are disabled (Default: ```15```)
`--tcpserverstransport.dialtimeout` :
Defines the amount of time to wait until a connection to a backend server can be established. If zero, no timeout exists. (Default: ```30```)
`--tcpserverstransport.terminationdelay` :
Defines the delay to wait before fully terminating the connection, after one connected peer has closed its writing capability. (Default: ```0```)
`--tcpserverstransport.tls` :
Defines the TLS configuration. (Default: ```false```)
`--tcpserverstransport.tls.insecureskipverify` :
Disables SSL certificate verification. (Default: ```false```)
`--tcpserverstransport.tls.rootcas` :
Defines a list of CA secret used to validate self-signed certificate
`--tcpserverstransport.tls.spiffe` :
Defines the SPIFFE TLS configuration. (Default: ```false```)
`--tcpserverstransport.tls.spiffe.ids` :
Defines the allowed SPIFFE IDs (takes precedence over the SPIFFE TrustDomain).
`--tcpserverstransport.tls.spiffe.trustdomain` :
Defines the allowed SPIFFE trust domain.
2019-07-08 09:00:04 +00:00
`--tracing` :
OpenTracing configuration. (Default: ```false```)
2024-01-30 15:28:05 +00:00
`--tracing.addinternals` :
Enables tracing for internal services (ping, dashboard, etc...). (Default: ```false```)
2024-01-08 08:10:06 +00:00
`--tracing.globalattributes.<name>` :
Defines additional attributes (key:value) on all spans.
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.headers.<name>` :
Defines additional headers to be sent with the payloads.
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp` :
2022-11-29 14:34:05 +00:00
Settings for OpenTelemetry. (Default: ```false```)
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.endpoint` :
Sets the gRPC endpoint (host:port) of the collector. (Default: ```localhost:4317```)
2022-11-29 14:34:05 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.insecure` :
2022-11-29 14:34:05 +00:00
Disables client transport security for the exporter. (Default: ```false```)
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.tls.ca` :
2022-11-29 14:34:05 +00:00
TLS CA
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.tls.cert` :
2022-11-29 14:34:05 +00:00
TLS cert
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.tls.insecureskipverify` :
2022-11-29 14:34:05 +00:00
TLS insecure skip verify (Default: ```false```)
2024-01-08 08:10:06 +00:00
`--tracing.otlp.grpc.tls.key` :
2022-11-29 14:34:05 +00:00
TLS key
2024-01-08 08:10:06 +00:00
`--tracing.otlp.http.endpoint` :
Sets the HTTP endpoint (scheme://host:port/v1/traces) of the collector. (Default: ```localhost:4318```)
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp.http.tls.ca` :
TLS CA
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp.http.tls.cert` :
TLS cert
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp.http.tls.insecureskipverify` :
TLS insecure skip verify (Default: ```false```)
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.otlp.http.tls.key` :
TLS key
2019-07-08 09:00:04 +00:00
2024-01-08 08:10:06 +00:00
`--tracing.samplerate` :
2021-09-29 08:40:14 +00:00
Sets the rate between 0.0 and 1.0 of requests to trace. (Default: ```1.000000```)
2024-01-08 08:10:06 +00:00
`--tracing.servicename` :
Set the name for this service. (Default: ```traefik```)