2024-10-24 10:55:59 +02:00

3.7 KiB

Raw Blame History

title	description
Traefik StripPrefix Documentation	In Traefik Proxy's HTTP middleware, StripPrefix removes prefixes from paths before forwarding requests. Read the technical documentation.

StripPrefix

Removing Prefixes From the Path Before Forwarding the Request {: .subtitle }

Remove the specified prefixes from the URL path.

Configuration Examples

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

# Strip prefix /foobar and /fiibar
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: test-stripprefix
spec:
  stripPrefix:
    prefixes:
      - /foobar
      - /fiibar

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

# Strip prefix /foobar and /fiibar
http:
  middlewares:
    test-stripprefix:
      stripPrefix:
        prefixes:
          - "/foobar"
          - "/fiibar"

# Strip prefix /foobar and /fiibar
[http.middlewares]
  [http.middlewares.test-stripprefix.stripPrefix]
    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 /image.png, which Traefik would likely not be able to associate with the same backend).

`forceSlash`

Optional, Default=true

!!! warning

`forceSlash` option is deprecated and should not be used.

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

??? info "Behavior examples"

- `forceSlash=true`

| Path       | Prefix to strip | Result |
|------------|-----------------|--------|
| `/`        | `/`             | `/`    |
| `/foo`     | `/foo`          | `/`    |
| `/foo/`    | `/foo`          | `/`    |
| `/foo/`    | `/foo/`         | `/`    |
| `/bar`     | `/foo`          | `/bar` |
| `/foo/bar` | `/foo`          | `/bar` |

- `forceSlash=false`

| Path       | Prefix to strip | Result |
|------------|-----------------|--------|
| `/`        | `/`             | empty  |
| `/foo`     | `/foo`          | empty  |
| `/foo/`    | `/foo`          | `/`    |
| `/foo/`    | `/foo/`         | empty  |
| `/bar`     | `/foo`          | `/bar` |
| `/foo/bar` | `/foo`          | `/bar` |

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

apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
  name: example
spec:
  stripPrefix:
    prefixes:
      - "/foobar"
    forceSlash: false

http:
  middlewares:
    example:
      stripPrefix:
        prefixes:
          - "/foobar"
        forceSlash: false

[http.middlewares]
  [http.middlewares.example.stripPrefix]
    prefixes = ["/foobar"]
    forceSlash = false

{!traefik-for-business-applications.md!}

3.7 KiB Raw Blame History