Static Configuration: CLI¶
--accesslog
:
Access log settings. (Default: false
)
--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
)
--api
:
Enable api/dashboard. (Default: false
)
--api.dashboard
:
Activate dashboard. (Default: true
)
--api.debug
:
Enable additional endpoints for debugging and profiling. (Default: false
)
--certificatesresolvers.<name>
:
Certificates resolvers configuration. (Default: false
)
--certificatesresolvers.<name>.acme.caserver
:
CA server to use. (Default: https://acme-v02.api.letsencrypt.org/directory
)
--certificatesresolvers.<name>.acme.dnschallenge
:
Activate DNS-01 Challenge. (Default: false
)
--certificatesresolvers.<name>.acme.dnschallenge.delaybeforecheck
:
Assume DNS propagates after a delay in seconds rather than finding and querying nameservers. (Default: 0
)
--certificatesresolvers.<name>.acme.dnschallenge.disablepropagationcheck
:
Disable the DNS propagation checks before notifying ACME that the DNS challenge is ready. [not recommended] (Default: false
)
--certificatesresolvers.<name>.acme.dnschallenge.provider
:
Use a DNS-01 based challenge provider rather than HTTPS.
--certificatesresolvers.<name>.acme.dnschallenge.resolvers
:
Use following DNS servers to resolve the FQDN authority.
--certificatesresolvers.<name>.acme.email
:
Email address used for registration.
--certificatesresolvers.<name>.acme.httpchallenge
:
Activate HTTP-01 Challenge. (Default: false
)
--certificatesresolvers.<name>.acme.httpchallenge.entrypoint
:
HTTP challenge EntryPoint
--certificatesresolvers.<name>.acme.keytype
:
KeyType used for generating certificate private key. Allow value 'EC256', 'EC384', 'RSA2048', 'RSA4096', 'RSA8192'. (Default: RSA4096
)
--certificatesresolvers.<name>.acme.storage
:
Storage to use. (Default: acme.json
)
--certificatesresolvers.<name>.acme.tlschallenge
:
Activate TLS-ALPN-01 Challenge. (Default: true
)
--entrypoints.<name>
:
Entry points definition. (Default: false
)
--entrypoints.<name>.address
:
Entry point address.
--entrypoints.<name>.forwardedheaders.insecure
:
Trust all forwarded headers. (Default: false
)
--entrypoints.<name>.forwardedheaders.trustedips
:
Trust only forwarded headers from selected IPs.
--entrypoints.<name>.proxyprotocol
:
Proxy-Protocol configuration. (Default: false
)
--entrypoints.<name>.proxyprotocol.insecure
:
Trust all. (Default: false
)
--entrypoints.<name>.proxyprotocol.trustedips
:
Trust only selected IPs.
--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
)
--global.checknewversion
:
Periodically check if a new version has been released. (Default: false
)
--global.sendanonymoususage
:
Periodically send anonymous usage statistics. If the option is not specified, it will be enabled by default. (Default: false
)
--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
)
--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
)
--metrics.datadog
:
DataDog metrics exporter type. (Default: false
)
--metrics.datadog.addentrypointslabels
:
Enable metrics on entry points. (Default: true
)
--metrics.datadog.address
:
DataDog's address. (Default: localhost:8125
)
--metrics.datadog.addserviceslabels
:
Enable metrics on services. (Default: true
)
--metrics.datadog.pushinterval
:
DataDog push interval. (Default: 10
)
--metrics.influxdb
:
InfluxDB metrics exporter type. (Default: false
)
--metrics.influxdb.addentrypointslabels
:
Enable metrics on entry points. (Default: true
)
--metrics.influxdb.address
:
InfluxDB address. (Default: localhost:8089
)
--metrics.influxdb.addserviceslabels
:
Enable metrics on services. (Default: true
)
--metrics.influxdb.database
:
InfluxDB database used when protocol is http.
--metrics.influxdb.password
:
InfluxDB password (only with http).
--metrics.influxdb.protocol
:
InfluxDB address protocol (udp or http). (Default: udp
)
--metrics.influxdb.pushinterval
:
InfluxDB push interval. (Default: 10
)
--metrics.influxdb.retentionpolicy
:
InfluxDB retention policy used when protocol is http.
--metrics.influxdb.username
:
InfluxDB username (only with http).
--metrics.prometheus
:
Prometheus metrics exporter type. (Default: false
)
--metrics.prometheus.addentrypointslabels
:
Enable metrics on entry points. (Default: true
)
--metrics.prometheus.addserviceslabels
:
Enable metrics on services. (Default: true
)
--metrics.prometheus.buckets
:
Buckets for latency metrics. (Default: 0.100000, 0.300000, 1.200000, 5.000000
)
--metrics.statsd
:
StatsD metrics exporter type. (Default: false
)
--metrics.statsd.addentrypointslabels
:
Enable metrics on entry points. (Default: true
)
--metrics.statsd.address
:
StatsD address. (Default: localhost:8125
)
--metrics.statsd.addserviceslabels
:
Enable metrics on services. (Default: true
)
--metrics.statsd.pushinterval
:
StatsD push interval. (Default: 10
)
--ping
:
Enable ping. (Default: true
)
--providers.docker
:
Enable Docker backend with default settings. (Default: false
)
--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
:
Docker server endpoint. Can be a tcp or a unix socket endpoint. (Default: unix:///var/run/docker.sock
)
--providers.docker.exposedbydefault
:
Expose containers by default. (Default: true
)
--providers.docker.network
:
Default Docker network used.
--providers.docker.swarmmode
:
Use Docker on Swarm Mode. (Default: false
)
--providers.docker.swarmmoderefreshseconds
:
Polling interval for swarm mode. (Default: 15
)
--providers.docker.tls.ca
:
TLS CA
--providers.docker.tls.caoptional
:
TLS CA.Optional (Default: false
)
--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
:
Watch provider. (Default: true
)
--providers.file.debugloggeneratedtemplate
:
Enable debug logging of generated configuration template. (Default: false
)
--providers.file.directory
:
Load configuration from one or more .toml files in a directory.
--providers.file.filename
:
Override default configuration template. For advanced users :)
--providers.file.watch
:
Watch provider. (Default: true
)
--providers.kubernetescrd
:
Enable Kubernetes backend with default settings. (Default: false
)
--providers.kubernetescrd.certauthfilepath
:
Kubernetes certificate authority file path (not needed for in-cluster client).
--providers.kubernetescrd.disablepasshostheaders
:
Kubernetes disable PassHost Headers. (Default: false
)
--providers.kubernetescrd.endpoint
:
Kubernetes server endpoint (required for external cluster client).
--providers.kubernetescrd.ingressclass
:
Value of kubernetes.io/ingress.class annotation to watch for.
--providers.kubernetescrd.labelselector
:
Kubernetes label selector to use.
--providers.kubernetescrd.namespaces
:
Kubernetes namespaces.
--providers.kubernetescrd.token
:
Kubernetes bearer token (not needed for in-cluster client).
--providers.kubernetesingress
:
Enable Kubernetes backend with default settings. (Default: false
)
--providers.kubernetesingress.certauthfilepath
:
Kubernetes certificate authority file path (not needed for in-cluster client).
--providers.kubernetesingress.disablepasshostheaders
:
Kubernetes disable PassHost Headers. (Default: false
)
--providers.kubernetesingress.endpoint
:
Kubernetes server endpoint (required for external cluster client).
--providers.kubernetesingress.ingressclass
:
Value of kubernetes.io/ingress.class annotation to watch for.
--providers.kubernetesingress.ingressendpoint.hostname
:
Hostname used for Kubernetes Ingress endpoints.
--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
:
Kubernetes namespaces.
--providers.kubernetesingress.token
:
Kubernetes bearer token (not needed for in-cluster client).
--providers.marathon
:
Enable Marathon backend with default settings. (Default: false
)
--providers.marathon.basic.httpbasicauthuser
:
Basic authentication User.
--providers.marathon.basic.httpbasicpassword
:
Basic authentication Password.
--providers.marathon.constraints
:
Constraints is an expression that Traefik matches against the application's labels to determine whether to create any route for that application.
--providers.marathon.dcostoken
:
DCOSToken for DCOS environment, This will override the Authorization header.
--providers.marathon.defaultrule
:
Default rule. (Default: Host(`{{ normalize .Name }}`)
)
--providers.marathon.dialertimeout
:
Set a dialer timeout for Marathon. (Default: 5
)
--providers.marathon.endpoint
:
Marathon server endpoint. You can also specify multiple endpoint for Marathon. (Default: http://127.0.0.1:8080
)
--providers.marathon.exposedbydefault
:
Expose Marathon apps by default. (Default: true
)
--providers.marathon.forcetaskhostname
:
Force to use the task's hostname. (Default: false
)
--providers.marathon.keepalive
:
Set a TCP Keep Alive time. (Default: 10
)
--providers.marathon.respectreadinesschecks
:
Filter out tasks with non-successful readiness checks during deployments. (Default: false
)
--providers.marathon.responseheadertimeout
:
Set a response header timeout for Marathon. (Default: 60
)
--providers.marathon.tls.ca
:
TLS CA
--providers.marathon.tls.caoptional
:
TLS CA.Optional (Default: false
)
--providers.marathon.tls.cert
:
TLS cert
--providers.marathon.tls.insecureskipverify
:
TLS insecure skip verify (Default: false
)
--providers.marathon.tls.key
:
TLS key
--providers.marathon.tlshandshaketimeout
:
Set a TLS handshake timeout for Marathon. (Default: 5
)
--providers.marathon.trace
:
Display additional provider logs. (Default: false
)
--providers.marathon.watch
:
Watch provider. (Default: true
)
--providers.providersthrottleduration
:
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: 0
)
--providers.rancher
:
Enable Rancher backend with default settings. (Default: false
)
--providers.rancher.constraints
:
Constraints is an expression that Traefik matches against the container's labels to determine whether to create any route for that container.
--providers.rancher.defaultrule
:
Default rule. (Default: Host(`{{ normalize .Name }}`)
)
--providers.rancher.enableservicehealthfilter
:
Filter services with unhealthy states and inactive states. (Default: true
)
--providers.rancher.exposedbydefault
:
Expose containers by default. (Default: true
)
--providers.rancher.intervalpoll
:
Poll the Rancher metadata service every 'rancher.refreshseconds' (less accurate). (Default: false
)
--providers.rancher.prefix
:
Prefix used for accessing the Rancher metadata service. (Default: latest
)
--providers.rancher.refreshseconds
:
Defines the polling interval in seconds. (Default: 15
)
--providers.rancher.watch
:
Watch provider. (Default: true
)
--providers.rest
:
Enable Rest backend with default settings. (Default: true
)
--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
:
If non-zero, controls the maximum idle (keep-alive) to keep per-host. If zero, DefaultMaxIdleConnsPerHost is used (Default: 0
)
--serverstransport.rootcas
:
Add cert file for self-signed certificate.
--tracing
:
OpenTracing configuration. (Default: false
)
--tracing.datadog
:
Settings for DataDog. (Default: false
)
--tracing.datadog.bagageprefixheadername
:
Specifies the header name prefix that will be used to store baggage items in a map.
--tracing.datadog.debug
:
Enable DataDog debug. (Default: false
)
--tracing.datadog.globaltag
:
Key:Value tag to be set on all the spans.
--tracing.datadog.localagenthostport
:
Set datadog-agent's host:port that the reporter will used. (Default: localhost:8126
)
--tracing.datadog.parentidheadername
:
Specifies the header name that will be used to store the parent ID.
--tracing.datadog.prioritysampling
:
Enable priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled. (Default: false
)
--tracing.datadog.samplingpriorityheadername
:
Specifies the header name that will be used to store the sampling priority.
--tracing.datadog.traceidheadername
:
Specifies the header name that will be used to store the trace ID.
--tracing.haystack
:
Settings for Haystack. (Default: false
)
--tracing.haystack.baggageprefixheadername
:
Specifies the header name prefix that will be used to store baggage items in a map.
--tracing.haystack.globaltag
:
Key:Value tag to be set on all the spans.
--tracing.haystack.localagenthost
:
Set haystack-agent's host that the reporter will used. (Default: LocalAgentHost
)
--tracing.haystack.localagentport
:
Set haystack-agent's port that the reporter will used. (Default: 35000
)
--tracing.haystack.parentidheadername
:
Specifies the header name that will be used to store the parent ID.
--tracing.haystack.spanidheadername
:
Specifies the header name that will be used to store the span ID.
--tracing.haystack.traceidheadername
:
Specifies the header name that will be used to store the trace ID.
--tracing.instana
:
Settings for Instana. (Default: false
)
--tracing.instana.localagenthost
:
Set instana-agent's host that the reporter will used. (Default: localhost
)
--tracing.instana.localagentport
:
Set instana-agent's port that the reporter will used. (Default: 42699
)
--tracing.instana.loglevel
:
Set instana-agent's log level. ('error','warn','info','debug') (Default: info
)
--tracing.jaeger
:
Settings for Jaeger. (Default: false
)
--tracing.jaeger.collector.endpoint
:
Instructs reporter to send spans to jaeger-collector at this URL.
--tracing.jaeger.collector.password
:
Password for basic http authentication when sending spans to jaeger-collector.
--tracing.jaeger.collector.user
:
User for basic http authentication when sending spans to jaeger-collector.
--tracing.jaeger.gen128bit
:
Generate 128 bit span IDs. (Default: false
)
--tracing.jaeger.localagenthostport
:
Set jaeger-agent's host:port that the reporter will used. (Default: 127.0.0.1:6831
)
--tracing.jaeger.propagation
:
Which propagation format to use (jaeger/b3). (Default: jaeger
)
--tracing.jaeger.samplingparam
:
Set the sampling parameter. (Default: 1.000000
)
--tracing.jaeger.samplingserverurl
:
Set the sampling server url. (Default: http://localhost:5778/sampling
)
--tracing.jaeger.samplingtype
:
Set the sampling type. (Default: const
)
--tracing.jaeger.tracecontextheadername
:
Set the header to use for the trace-id. (Default: uber-trace-id
)
--tracing.servicename
:
Set the name for this service. (Default: traefik
)
--tracing.spannamelimit
:
Set the maximum character limit for Span names (default 0 = no limit). (Default: 0
)
--tracing.zipkin
:
Settings for Zipkin. (Default: false
)
--tracing.zipkin.debug
:
Enable Zipkin debug. (Default: false
)
--tracing.zipkin.httpendpoint
:
HTTP Endpoint to report traces to. (Default: http://localhost:9411/api/v1/spans
)
--tracing.zipkin.id128bit
:
Use Zipkin 128 bit root span IDs. (Default: true
)
--tracing.zipkin.samespan
:
Use Zipkin SameSpan RPC style traces. (Default: false
)
--tracing.zipkin.samplerate
:
The rate between 0.0 and 1.0 of requests to trace. (Default: 1.000000
)