Middlewares

Tweaking the Request

Overview

Attached to the routers, pieces of middleware are a means of tweaking the requests before they are sent to your service (or before the answer from the services are sent to the clients).

There are several available middleware in Traefik, some can modify the request, the headers, some are in charge of redirections, some add authentication, and so on.

Middlewares that use the same protocol can be combined into chains to fit every scenario.

Provider Namespace

Be aware of the concept of Providers Namespace described in the Configuration Discovery section. It also applies to Middlewares.

Configuration Example

Docker & Swarm

  1. # As a Docker Label
  2. whoami:
  3.   #  A container that exposes an API to show its IP address
  4.   image: traefik/whoami
  5.   labels:
  6.     # Create a middleware named `foo-add-prefix`
  7.     - "traefik.http.middlewares.foo-add-prefix.addprefix.prefix=/foo"
  8.     # Apply the middleware named `foo-add-prefix` to the router named `router1`
  9.     - "traefik.http.routers.router1.middlewares=foo-add-prefix@docker"

Kubernetes IngressRoute

  1. ---
  2. apiVersion: traefik.io/v1alpha1
  3. kind: Middleware
  4. metadata:
  5.   name: stripprefix
  6. spec:
  7.   stripPrefix:
  8.     prefixes:
  9.       - /stripit
  11. ---
  12. apiVersion: traefik.io/v1alpha1
  13. kind: IngressRoute
  14. metadata:
  15.   name: ingressroute
  16. spec:
  17. # more fields...
  18.   routes:
  19.     # more fields...
  20.     middlewares:
  21.       - name: stripprefix

Consul Catalog

  1. # Create a middleware named `foo-add-prefix`
  2. - "traefik.http.middlewares.foo-add-prefix.addprefix.prefix=/foo"
  3. # Apply the middleware named `foo-add-prefix` to the router named `router1`
  4. - "traefik.http.routers.router1.middlewares=foo-add-prefix@consulcatalog"

File (YAML)

  1. # As YAML Configuration File
  2. http:
  3.   routers:
  4.     router1:
  5.       service: myService
  6.       middlewares:
  7.         - "foo-add-prefix"
  8.       rule: "Host(`example.com`)"
  10.   middlewares:
  11.     foo-add-prefix:
  12.       addPrefix:
  13.         prefix: "/foo"
  15.   services:
  16.     service1:
  17.       loadBalancer:
  18.         servers:
  19.           - url: "http://127.0.0.1:80"

File (TOML)

  1. # As TOML Configuration File
  2. [http.routers]
  3.   [http.routers.router1]
  4.     service = "myService"
  5.     middlewares = ["foo-add-prefix"]
  6.     rule = "Host(`example.com`)"
  8. [http.middlewares]
  9.   [http.middlewares.foo-add-prefix.addPrefix]
  10.     prefix = "/foo"
  12. [http.services]
  13.   [http.services.service1]
  14.     [http.services.service1.loadBalancer]
  16.       [[http.services.service1.loadBalancer.servers]]
  17.         url = "http://127.0.0.1:80"

Available Middlewares

A list of HTTP middlewares can be found here.

A list of TCP middlewares can be found here.

Using Traefik OSS in Production? Consider Adding Advanced Capabilities.

Add API Gateway or API Management capabilities seamlessly to your existing Traefik deployments. No rip and replace. No learning curve.