site_name: Traefik site_description: Traefik Documentation site_author: traefik.io site_url: https://doc.traefik.io/traefik dev_addr: 0.0.0.0:8000 repo_name: 'GitHub' repo_url: 'https://github.com/traefik/traefik' docs_dir: 'content' product: proxy # https://squidfunk.github.io/mkdocs-material/ theme: name: 'traefik-labs' language: en include_sidebar: true favicon: assets/img/traefikproxy-icon-color.png logo: assets/img/traefikproxy-vertical-logo-color.svg feature: tabs: false palette: primary: 'cyan' accent: 'cyan' i18n: prev: 'Previous' next: 'Next' copyright: 'Traefik Labs • Copyright © 2016-2025' extra_javascript: - assets/js/hljs/highlight.pack.js # Download from https://highlightjs.org/download/ and enable YAML, TOML and Dockerfile - assets/js/extra.js extra_css: - assets/css/menu-icons.css plugins: - search - exclude: glob: - "**/include-*.md" - redirects: redirect_maps: # Providers 'providers/overview.md': 'reference/install-configuration/providers/overview.md' 'providers/docker.md': 'reference/install-configuration/providers/docker.md' 'providers/swarm.md': 'reference/install-configuration/providers/swarm.md' 'providers/kubernetes-crd.md': 'reference/install-configuration/providers/kubernetes/kubernetes-crd.md' 'providers/kubernetes-ingress.md': 'reference/install-configuration/providers/kubernetes/kubernetes-ingress.md' 'providers/kubernetes-gateway.md': 'reference/install-configuration/providers/kubernetes/kubernetes-gateway.md' 'providers/consul-catalog.md': 'reference/install-configuration/providers/hashicorp/consul-catalog.md' 'providers/nomad.md': 'reference/install-configuration/providers/hashicorp/nomad.md' 'providers/ecs.md': 'reference/install-configuration/providers/others/ecs.md' 'providers/file.md': 'reference/install-configuration/providers/others/file.md' 'providers/consul.md': 'reference/install-configuration/providers/kv/consul.md' 'providers/etcd.md': 'reference/install-configuration/providers/kv/etcd.md' 'providers/zookeeper.md': 'reference/install-configuration/providers/kv/zk.md' 'providers/redis.md': 'reference/install-configuration/providers/kv/redis.md' 'providers/http.md': 'reference/install-configuration/providers/others/http.md' # Routing 'routing/overview.md': 'reference/routing-configuration/dynamic-configuration-methods.md' 'routing/entrypoints.md': 'reference/install-configuration/entrypoints.md' 'routing/routers/index.md': 'reference/routing-configuration/http/router/rules-and-priority.md' 'routing/services/index.md': 'reference/routing-configuration/http/load-balancing/service.md' 'routing/providers/docker.md': 'reference/routing-configuration/other-providers/docker.md' 'routing/providers/swarm.md': 'reference/routing-configuration/other-providers/swarm.md' 'routing/providers/kubernetes-crd.md': 'reference/routing-configuration/kubernetes/crd/http/ingressroute.md' 'routing/providers/kubernetes-ingress.md': 'reference/routing-configuration/kubernetes/ingress.md' 'routing/providers/kubernetes-gateway.md': 'reference/routing-configuration/kubernetes/gateway-api.md' 'routing/providers/consul-catalog.md': 'reference/routing-configuration/other-providers/consul-catalog.md' 'routing/providers/nomad.md': 'reference/routing-configuration/other-providers/nomad.md' 'routing/providers/ecs.md': 'reference/routing-configuration/other-providers/ecs.md' 'routing/providers/kv.md': 'reference/routing-configuration/other-providers/kv.md' # Observability 'observability/overview.md': 'observe/overview.md' 'observability/logs.md': 'reference/install-configuration/observability/logs-and-accesslogs.md' 'observability/access-logs.md': 'reference/install-configuration/observability/logs-and-accesslogs.md' 'observability/metrics/overview.md': 'reference/install-configuration/observability/metrics.md' 'observability/metrics/datadog.md': 'reference/install-configuration/observability/metrics.md' 'observability/metrics/influxdb2.md': 'reference/install-configuration/observability/metrics.md' 'observability/metrics/opentelemetry.md': 'reference/install-configuration/observability/metrics.md' 'observability/metrics/prometheus.md': 'reference/install-configuration/observability/metrics.md' 'observability/metrics/statsd.md': 'reference/install-configuration/observability/metrics.md' 'observability/tracing/overview.md': 'reference/install-configuration/observability/tracing.md' 'observability/tracing/opentelemetry.md': 'reference/install-configuration/observability/tracing.md' # Operations 'operations/cli.md': 'reference/install-configuration/observability/healthcheck.md' 'operations/dashboard.md': 'reference/install-configuration/api-dashboard.md' 'operations/api.md': 'reference/install-configuration/api-dashboard.md' 'operations/ping.md': 'reference/install-configuration/observability/healthcheck.md' # HTTPS & TLS 'https/overview.md': 'reference/routing-configuration/http/tls/overview.md' 'https/tls.md': 'reference/routing-configuration/http/tls/tls-certificates.md' 'https/acme.md': 'reference/install-configuration/tls/certificate-resolvers/acme.md' 'https/tailscale.md': 'reference/install-configuration/tls/certificate-resolvers/tailscale.md' 'https/spiffe.md': 'reference/install-configuration/tls/spiffe.md' # Middlewares 'middlewares/overview.md': 'reference/routing-configuration/http/middlewares/overview.md' # HTTP 'middlewares/http/overview.md': 'reference/routing-configuration/http/middlewares/overview.md' 'middlewares/http/addprefix.md': 'reference/routing-configuration/http/middlewares/addprefix.md' 'middlewares/http/basicauth.md': 'reference/routing-configuration/http/middlewares/basicauth.md' 'middlewares/http/buffering.md': 'reference/routing-configuration/http/middlewares/buffering.md' 'middlewares/http/chain.md': 'reference/routing-configuration/http/middlewares/chain.md' 'middlewares/http/circuitbreaker.md': 'reference/routing-configuration/http/middlewares/circuitbreaker.md' 'middlewares/http/compress.md': 'reference/routing-configuration/http/middlewares/compress.md' 'middlewares/http/contenttype.md': 'reference/routing-configuration/http/middlewares/contenttype.md' 'middlewares/http/digestauth.md': 'reference/routing-configuration/http/middlewares/digestauth.md' 'middlewares/http/errorpages.md': 'reference/routing-configuration/http/middlewares/errorpages.md' 'middlewares/http/forwardauth.md': 'reference/routing-configuration/http/middlewares/forwardauth.md' 'middlewares/http/grpcweb.md': 'reference/routing-configuration/http/middlewares/grpcweb.md' 'middlewares/http/headers.md': 'reference/routing-configuration/http/middlewares/headers.md' 'middlewares/http/ipwhitelist.md': 'reference/routing-configuration/http/middlewares/ipallowlist.md' 'middlewares/http/ipallowlist.md': 'reference/routing-configuration/http/middlewares/ipallowlist.md' 'middlewares/http/inflightreq.md': 'reference/routing-configuration/http/middlewares/inflightreq.md' 'middlewares/http/passtlsclientcert.md': 'reference/routing-configuration/http/middlewares/passtlsclientcert.md' 'middlewares/http/ratelimit.md': 'reference/routing-configuration/http/middlewares/ratelimit.md' 'middlewares/http/redirectregex.md': 'reference/routing-configuration/http/middlewares/redirectregex.md' 'middlewares/http/redirectscheme.md': 'reference/routing-configuration/http/middlewares/redirectscheme.md' 'middlewares/http/replacepath.md': 'reference/routing-configuration/http/middlewares/replacepath.md' 'middlewares/http/replacepathregex.md': 'reference/routing-configuration/http/middlewares/replacepathregex.md' 'middlewares/http/retry.md': 'reference/routing-configuration/http/middlewares/retry.md' 'middlewares/http/stripprefix.md': 'reference/routing-configuration/http/middlewares/stripprefix.md' 'middlewares/http/stripprefixregex.md': 'reference/routing-configuration/http/middlewares/stripprefixregex.md' # TCP 'middlewares/tcp/overview.md': 'reference/routing-configuration/tcp/middlewares/overview.md' 'middlewares/tcp/inflightconn.md': 'reference/routing-configuration/tcp/middlewares/inflightconn.md' 'middlewares/tcp/ipwhitelist.md': 'reference/routing-configuration/tcp/middlewares/ipallowlist.md' 'middlewares/tcp/ipallowlist.md': 'reference/routing-configuration/tcp/middlewares/ipallowlist.md' ## User Guides 'user-guides/crd-acme/index.md': 'expose/kubernetes.md' 'user-guides/cert-manager.md': 'expose/kubernetes.md' 'user-guides/docker-compose/basic-example/index.md': 'expose/docker.md' 'user-guides/docker-compose/acme-tls/index.md': 'expose/docker.md' 'user-guides/docker-compose/acme-http/index.md': 'expose/docker.md' 'user-guides/docker-compose/acme-dns/index.md': 'expose/docker.md' # References # Static Configuration 'reference/static-configuration/overview.md': 'reference/install-configuration/configuration-options.md' 'reference/static-configuration/file.md': 'reference/install-configuration/configuration-options.md' 'reference/static-configuration/cli.md': 'reference/install-configuration/configuration-options.md' 'reference/static-configuration/env.md': 'reference/install-configuration/configuration-options.md' # Dynamic Configuration 'reference/dynamic-configuration/file.md': 'reference/routing-configuration/other-providers/file.md' 'reference/dynamic-configuration/docker.md': 'reference/routing-configuration/other-providers/docker.md' 'reference/dynamic-configuration/kubernetes-crd.md': 'reference/routing-configuration/kubernetes/crd/http/ingressroute.md' 'reference/dynamic-configuration/kubernetes-gateway.md': 'reference/routing-configuration/kubernetes/gateway-api.md' 'reference/dynamic-configuration/consul-catalog.md': 'reference/routing-configuration/other-providers/consul-catalog.md' "reference/dynamic-configuration/nomad.md": 'reference/routing-configuration/other-providers/nomad.md' 'reference/dynamic-configuration/ecs.md': 'reference/routing-configuration/other-providers/ecs.md' 'reference/dynamic-configuration/kv.md': 'reference/routing-configuration/other-providers/kv.md' ## Plugins 'plugins/index.md': "extend/extend-traefik.md" ## Migration 'migration/v3.md': 'migrate/v3.md' 'migration/v2-to-v3.md': 'migrate/v2-to-v3.md' 'migration/v2-to-v3-details.md': 'migrate/v2-to-v3-details.md' 'migration/v2.md': 'migrate/v2.md' 'migration/v1-to-v2.md': 'migrate/v1-to-v2.md' # https://squidfunk.github.io/mkdocs-material/extensions/admonition/ # https://facelessuser.github.io/pymdown-extensions/ markdown_extensions: - meta - attr_list - admonition - footnotes - pymdownx.details - pymdownx.inlinehilite - pymdownx.highlight: use_pygments: false # hljs is used instead of pygment for TOML highlighting support - pymdownx.smartsymbols - pymdownx.superfences - pymdownx.tabbed - pymdownx.tasklist - pymdownx.snippets: check_paths: true - markdown_include.include: base_path: content/includes/ encoding: utf-8 - toc: permalink: true # Page tree nav: - 'What is Traefik': 'index.md' - 'Getting Started': - 'Overview': 'getting-started/index.md' - 'Quick Start': - 'Kubernetes': 'getting-started/kubernetes.md' - 'Docker': 'getting-started/docker.md' - 'Configuration Introduction': 'getting-started/configuration-overview.md' - 'Setup': - 'Kubernetes': 'setup/kubernetes.md' - 'Docker': 'setup/docker.md' - 'Swarm': 'setup/swarm.md' - 'Expose': - 'Overview': 'expose/overview.md' - 'Kubernetes': 'expose/kubernetes.md' - 'Docker': 'expose/docker.md' - 'Swarm': 'expose/swarm.md' - 'Secure': - 'Secure Access with JWT Traefik Hub API Gateway': 'secure/secure-api-access-with-jwt.md' - 'Secure Access with OIDC Traefik Hub API Gateway': 'secure/secure-api-access-with-oidc.md' - 'Secure Access with a WAF Traefik Hub API Gateway': 'secure/secure-api-access-with-waf.md' - 'Observe': - 'Overview': 'observe/overview.md' - 'Logs & Access Logs': 'observe/logs-and-access-logs.md' - 'Metrics': 'observe/metrics.md' - 'Tracing': 'observe/tracing.md' - 'Extend': 'extend/extend-traefik.md' - 'Govern Traefik Hub API Gateway': 'govern/index.md' - 'Migrate': - 'Traefik v3 minor migrations': 'migrate/v3.md' - 'Traefik v2 to v3': - 'Migration guide': 'migrate/v2-to-v3.md' - 'Configuration changes for v3': 'migrate/v2-to-v3-details.md' - 'Traefik v2 minor migrations': 'migrate/v2.md' - 'Traefik v1 to v2': 'migrate/v1-to-v2.md' - 'Reference': - 'Install Configuration': - 'Boot Environment': 'reference/install-configuration/boot-environment.md' - 'Configuration Discovery': - 'Overview' : 'reference/install-configuration/providers/overview.md' - 'Kubernetes': - 'Kubernetes Gateway API' : 'reference/install-configuration/providers/kubernetes/kubernetes-gateway.md' - 'Kubernetes CRD' : 'reference/install-configuration/providers/kubernetes/kubernetes-crd.md' - 'Kubernetes Ingress' : 'reference/install-configuration/providers/kubernetes/kubernetes-ingress.md' - 'Kubernetes Ingress NGINX' : 'reference/install-configuration/providers/kubernetes/kubernetes-ingress-nginx.md' - 'Docker': 'reference/install-configuration/providers/docker.md' - 'Swarm': 'reference/install-configuration/providers/swarm.md' - 'Hashicorp': - 'Nomad': "reference/install-configuration/providers/hashicorp/nomad.md" - 'Consul': 'reference/install-configuration/providers/hashicorp/consul.md' - 'Consul Catalog': 'reference/install-configuration/providers/hashicorp/consul-catalog.md' - 'KV Stores': - 'Redis': 'reference/install-configuration/providers/kv/redis.md' - 'Consul': 'reference/install-configuration/providers/kv/consul.md' - 'etcd': 'reference/install-configuration/providers/kv/etcd.md' - 'ZooKeeper' : 'reference/install-configuration/providers/kv/zk.md' - 'Others': - 'File': 'reference/install-configuration/providers/others/file.md' - 'ECS': 'reference/install-configuration/providers/others/ecs.md' - 'HTTP': 'reference/install-configuration/providers/others/http.md' - 'EntryPoints': 'reference/install-configuration/entrypoints.md' - 'API & Dashboard': 'reference/install-configuration/api-dashboard.md' - 'TLS': - 'Certificate Resolvers': - "Overview" : 'reference/install-configuration/tls/certificate-resolvers/overview.md' - "ACME" : 'reference/install-configuration/tls/certificate-resolvers/acme.md' - "Tailscale" : 'reference/install-configuration/tls/certificate-resolvers/tailscale.md' - "SPIFFE" : 'reference/install-configuration/tls/spiffe.md' - "OCSP" : 'reference/install-configuration/tls/ocsp.md' - 'Observability': - 'Metrics' : 'reference/install-configuration/observability/metrics.md' - 'Tracing': 'reference/install-configuration/observability/tracing.md' - 'Logs & AccessLogs': 'reference/install-configuration/observability/logs-and-accesslogs.md' - 'Health Check (CLI & Ping)': 'reference/install-configuration/observability/healthcheck.md' - 'Options List': 'reference/install-configuration/configuration-options.md' - 'Routing Configuration': - 'Common Configuration' : - 'Configuration Methods' : 'reference/routing-configuration/dynamic-configuration-methods.md' - 'HTTP' : - 'Routing' : - 'Router' : 'reference/routing-configuration/http/routing/router.md' - 'Rules & Priority' : 'reference/routing-configuration/http/routing/rules-and-priority.md' - 'Observability': 'reference/routing-configuration/http/routing/observability.md' - 'Load Balancing' : - 'Service' : 'reference/routing-configuration/http/load-balancing/service.md' - 'ServersTransport' : 'reference/routing-configuration/http/load-balancing/serverstransport.md' - 'TLS' : - 'Overview' : 'reference/routing-configuration/http/tls/overview.md' - 'TLS Certificates' : 'reference/routing-configuration/http/tls/tls-certificates.md' - 'TLS Options' : 'reference/routing-configuration/http/tls/tls-options.md' - 'Middlewares' : - 'Overview' : 'reference/routing-configuration/http/middlewares/overview.md' - 'AddPrefix' : 'reference/routing-configuration/http/middlewares/addprefix.md' - 'APIKey Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/apikey.md' - 'BasicAuth' : 'reference/routing-configuration/http/middlewares/basicauth.md' - 'Buffering': 'reference/routing-configuration/http/middlewares/buffering.md' - 'Chain': 'reference/routing-configuration/http/middlewares/chain.md' - 'Circuit Breaker' : 'reference/routing-configuration/http/middlewares/circuitbreaker.md' - 'Compress': 'reference/routing-configuration/http/middlewares/compress.md' - 'ContentType': 'reference/routing-configuration/http/middlewares/contenttype.md' - 'DigestAuth': 'reference/routing-configuration/http/middlewares/digestauth.md' - 'Distributed RateLimit Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/distributed-ratelimit.md' - 'Errors': 'reference/routing-configuration/http/middlewares/errorpages.md' - 'ForwardAuth': 'reference/routing-configuration/http/middlewares/forwardauth.md' - 'GrpcWeb': 'reference/routing-configuration/http/middlewares/grpcweb.md' - 'Headers': 'reference/routing-configuration/http/middlewares/headers.md' - 'HMAC Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/hmac.md' - 'IPAllowList': 'reference/routing-configuration/http/middlewares/ipallowlist.md' - 'InFlightReq': 'reference/routing-configuration/http/middlewares/inflightreq.md' - 'JWT Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/jwt.md' - 'LDAP Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/ldap.md' - 'Token Introspection Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/oauth2-token-introspection.md' - 'Client Credentials Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/oauth2-client-credentials.md' - 'OIDC Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/oidc.md' - 'OPA Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/opa.md' - 'PassTLSClientCert': 'reference/routing-configuration/http/middlewares/passtlsclientcert.md' - 'RateLimit': 'reference/routing-configuration/http/middlewares/ratelimit.md' - 'RedirectRegex': 'reference/routing-configuration/http/middlewares/redirectregex.md' - 'RedirectScheme': 'reference/routing-configuration/http/middlewares/redirectscheme.md' - 'ReplacePath': 'reference/routing-configuration/http/middlewares/replacepath.md' - 'ReplacePathRegex': 'reference/routing-configuration/http/middlewares/replacepathregex.md' - 'Retry': 'reference/routing-configuration/http/middlewares/retry.md' - 'StripPrefix': 'reference/routing-configuration/http/middlewares/stripprefix.md' - 'StripPrefixRegex': 'reference/routing-configuration/http/middlewares/stripprefixregex.md' - 'WAF Traefik Hub API Gateway' : 'reference/routing-configuration/http/middlewares/waf.md' - 'TCP' : - 'Routing' : - 'Router' : 'reference/routing-configuration/tcp/routing/router.md' - 'Rules & Priority' : 'reference/routing-configuration/tcp/routing/rules-and-priority.md' - 'Service' : 'reference/routing-configuration/tcp/service.md' - 'ServersTransport' : 'reference/routing-configuration/tcp/serverstransport.md' - 'TLS' : 'reference/routing-configuration/tcp/tls.md' - 'Middlewares' : - 'Overview' : 'reference/routing-configuration/tcp/middlewares/overview.md' - 'InFlightConn' : 'reference/routing-configuration/tcp/middlewares/inflightconn.md' - 'IPAllowList' : 'reference/routing-configuration/tcp/middlewares/ipallowlist.md' - 'UDP' : - 'Routing' : - 'Router' : 'reference/routing-configuration/udp/routing/router.md' - 'Rules & Priority' : 'reference/routing-configuration/udp/routing/rules-priority.md' - 'Service' : 'reference/routing-configuration/udp/service.md' - 'Kubernetes': - 'Gateway API' : 'reference/routing-configuration/kubernetes/gateway-api.md' - 'Kubernetes CRD' : - 'HTTP' : - 'IngressRoute' : 'reference/routing-configuration/kubernetes/crd/http/ingressroute.md' - 'Service' : 'reference/routing-configuration/kubernetes/crd/http/service.md' - 'TraefikService' : 'reference/routing-configuration/kubernetes/crd/http/traefikservice.md' - 'ServersTransport' : 'reference/routing-configuration/kubernetes/crd/http/serverstransport.md' - 'Middleware' : 'reference/routing-configuration/kubernetes/crd/http/middleware.md' - 'TLSOption' : 'reference/routing-configuration/kubernetes/crd/http/tlsoption.md' - 'TLSStore' : 'reference/routing-configuration/kubernetes/crd/http/tlsstore.md' - 'TCP' : - 'IngressRouteTCP' : 'reference/routing-configuration/kubernetes/crd/tcp/ingressroutetcp.md' - 'ServersTransportTCP' : 'reference/routing-configuration/kubernetes/crd/tcp/serverstransporttcp.md' - 'MiddlewareTCP' : 'reference/routing-configuration/kubernetes/crd/tcp/middlewaretcp.md' - 'TLSOption' : 'reference/routing-configuration/kubernetes/crd/tcp/tlsoption.md' - 'TLSStore' : 'reference/routing-configuration/kubernetes/crd/tcp/tlsstore.md' - 'UDP' : - 'IngressRouteUDP' : 'reference/routing-configuration/kubernetes/crd/udp/ingressrouteudp.md' - 'Ingress' : 'reference/routing-configuration/kubernetes/ingress.md' - 'Ingress NGINX' : 'reference/routing-configuration/kubernetes/ingress-nginx.md' - 'Label & Tag Providers' : - 'Docker' : 'reference/routing-configuration/other-providers/docker.md' - 'Swarm' : 'reference/routing-configuration/other-providers/swarm.md' - 'Consul Catalog' : 'reference/routing-configuration/other-providers/consul-catalog.md' - 'Nomad' : 'reference/routing-configuration/other-providers/nomad.md' - 'ECS' : 'reference/routing-configuration/other-providers/ecs.md' - 'KV' : 'reference/routing-configuration/other-providers/kv.md' - 'File' : 'reference/routing-configuration/other-providers/file.md' - 'Security': - 'Content-Length': 'security/content-length.md' - 'TLS in Multi-Tenant Kubernetes': 'security/tls-certs-in-multi-tenant-kubernetes.md' - 'Deprecation Notices': - 'Releases': 'deprecation/releases.md' - 'Features': 'deprecation/features.md' - 'User Guides': - 'FastProxy': 'user-guides/fastproxy.md' - 'gRPC Examples': 'user-guides/grpc.md' - 'WebSocket Examples': 'user-guides/websocket.md' - 'Contributing': - 'Thank You!': 'contributing/thank-you.md' - 'Submitting Issues': 'contributing/submitting-issues.md' - 'Submitting PRs': 'contributing/submitting-pull-requests.md' - 'Security': 'contributing/submitting-security-issues.md' - 'Building and Testing': 'contributing/building-testing.md' - 'Documentation': 'contributing/documentation.md' - 'Data Collection': 'contributing/data-collection.md' - 'Advocating': 'contributing/advocating.md' - 'Maintainers': 'contributing/maintainers.md' - 'FAQ': 'getting-started/faq.md'