StripPrefix

    Remove the specified prefixes from the URL path.

    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. # Strip prefix /foobar and /fiibar
    1. "labels": {
    2.   "traefik.http.middlewares.test-stripprefix.stripprefix.prefixes": "/foobar,/fiibar"
    3. }
    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

    The StripPrefix middleware will:

    • strip the matching path prefix.

    Tip

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

    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).

    Optional, Default=true

    1. labels:
    2.   - "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
    3.   - "traefik.http.middlewares.example.stripprefix.forceslash=false"
    1. "labels": {
    2.   "traefik.http.middlewares.example.stripprefix.prefixes": "/foobar",
    3.   "traefik.http.middlewares.example.stripprefix.forceslash": "false"
    4. }
    1. labels:
    2.   - "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
    3.   - "traefik.http.middlewares.example.stripprefix.forceSlash=false"
    1. [http.middlewares]
    2.   [http.middlewares.example.stripPrefix]
    3.     prefixes = ["/foobar"]
    4.     forceSlash = false

    The forceSlash option makes sure that 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's recommended to explicitly set forceSlash to false.

    • forceSlash=true
    • forceSlash=false
    Path Prefix to strip Result
    / / empty
    /foo /foo empty
    /foo/ /foo /
    /foo/ /foo/ empty
    /bar /foo /bar
    /foo/bar /bar