StripPrefix

Removing Prefixes From the Path Before Forwarding the Request

Remove the specified prefixes from the URL path.

Configuration Examples

  1. # Strip prefix /foobar and /fiibar
  2. labels:
  3. - "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes=/foobar,/fiibar"
  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
  1. "labels": {
  2.   "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes": "/foobar,/fiibar"
  3. }
  1. # Strip prefix /foobar and /fiibar
  2. labels:
  3. - "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes=/foobar,/fiibar"
  1. # Strip prefix /foobar and /fiibar
  2. [http.middlewares]
  3.   [http.middlewares.test-stripprefix.stripPrefix]
  4.     prefixes = ["/foobar", "/fiibar"]
  1. # Strip prefix /foobar and /fiibar
  2. http:
  3.   middlewares:
  4.     test-stripprefix:
  5.       stripPrefix:
  6.         prefixes:
  7.         - "/foobar"
  8.         - "/fiibar"

Configuration Options

General

The StripPrefix middleware will:

  • strip the matching path prefix.
  • store the matching path prefix in a X-Forwarded-Prefix header.

Tip

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

prefixes

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

For instance, /products would match /products but also /products/shoes and /products/shirts.

Since the path is stripped prior to forwarding, your backend is expected to listen on /.

If your backend is serving assets (e.g., images or Javascript files), chances are it must return properly constructed relative URLs.Continuing on the 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).

The X-Forwarded-Prefix header can be queried to build such URLs dynamically.