StripPrefix

Removing Prefixes From the Path Before Forwarding the Request

Remove the specified prefixes from the URL path.

Configuration Examples

Docker

  1. # Strip prefix /foobar and /fiibar
  2. labels:
  3. - "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes=/foobar,/fiibar"

Kubernetes

  1. # Strip prefix /foobar and /fiibar
  2. apiVersion: traefik.containo.us/v1alpha1
  3. kind: Middleware
  4. metadata:
  5. name: test-stripprefix
  6. spec:
  7. stripPrefix:
  8. prefixes:
  9. - /foobar
  10. - /fiibar

Consul Catalog

  1. # Strip prefix /foobar and /fiibar
  2. - "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes=/foobar,/fiibar"

Marathon

  1. "labels": {
  2. "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes": "/foobar,/fiibar"
  3. }

Rancher

  1. # Strip prefix /foobar and /fiibar
  2. labels:
  3. - "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes=/foobar,/fiibar"

File (YAML)

  1. # Strip prefix /foobar and /fiibar
  2. http:
  3. middlewares:
  4. test-stripprefix:
  5. stripPrefix:
  6. prefixes:
  7. - "/foobar"
  8. - "/fiibar"

File (TOML)

  1. # Strip prefix /foobar and /fiibar
  2. [http.middlewares]
  3. [http.middlewares.test-stripprefix.stripPrefix]
  4. prefixes = ["/foobar", "/fiibar"]

Configuration Options

General

The StripPrefix middleware strips the matching path prefix and stores it in a X-Forwarded-Prefix header.

Tip

Use a StripPrefix middleware if your backend listens on the root path (/) but should be exposed on a specific prefix.

prefixes

The prefixes option defines the prefixes to strip from the request URL.

For instance, /products also matches /products/shoes and /products/shirts.

If your backend is serving assets (e.g., images or JavaScript files), it can use the X-Forwarded-Prefix header to properly construct relative URLs. Using the previous example, the backend should return /products/shoes/image.png (and not /images.png, which Traefik would likely not be able to associate with the same backend).

forceSlash

Optional, Default=true

The forceSlash option ensures the resulting stripped path is not the empty string, by replacing it with / when necessary.

This option was added to keep the initial (non-intuitive) behavior of this middleware, in order to avoid introducing a breaking change.

It is recommended to explicitly set forceSlash to false.

Behavior examples

  • forceSlash=true
PathPrefix to stripResult
///
/foo/foo/
/foo//foo/
/foo//foo//
/bar/foo/bar
/foo/bar/foo/bar
  • forceSlash=false
PathPrefix to stripResult
//empty
/foo/fooempty
/foo//foo/
/foo//foo/empty
/bar/foo/bar
/foo/bar/foo/bar

Docker

  1. labels:
  2. - "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
  3. - "traefik.http.middlewares.example.stripprefix.forceSlash=false"

Kubernetes

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4. name: example
  5. spec:
  6. stripPrefix:
  7. prefixes:
  8. - "/foobar"
  9. forceSlash: false

Marathon

  1. "labels": {
  2. "traefik.http.middlewares.example.stripprefix.prefixes": "/foobar",
  3. "traefik.http.middlewares.example.stripprefix.forceSlash": "false"
  4. }

Rancher

  1. labels:
  2. - "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
  3. - "traefik.http.middlewares.example.stripprefix.forceSlash=false"

File (YAML)

  1. http:
  2. middlewares:
  3. example:
  4. stripPrefix:
  5. prefixes:
  6. - "/foobar"
  7. forceSlash: false

File (TOML)

  1. [http.middlewares]
  2. [http.middlewares.example.stripPrefix]
  3. prefixes = ["/foobar"]
  4. forceSlash = false