StripPrefix
Remove the specified prefixes from the URL path.
Docker
Kubernetes
# Strip prefix /foobar and /fiibar
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
name: test-stripprefix
spec:
stripPrefix:
prefixes:
- /foobar
- /fiibar
Consul Catalog
# Strip prefix /foobar and /fiibar
Marathon
"labels": {
"traefik.http.middlewares.test-stripprefix.stripprefix.prefixes": "/foobar,/fiibar"
}
Rancher
File (YAML)
# 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
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.
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).
Optional, Default=true
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
Path | Prefix to strip | Result |
---|---|---|
/ | / | empty |
/foo | /foo | empty |
/foo/ | /foo | / |
/foo/ | /foo/ | empty |
/bar | /foo | /bar |
/foo/bar | /foo | /bar |
Docker
labels:
- "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
- "traefik.http.middlewares.example.stripprefix.forceSlash=false"
Kubernetes
Marathon
"labels": {
"traefik.http.middlewares.example.stripprefix.prefixes": "/foobar",
"traefik.http.middlewares.example.stripprefix.forceSlash": "false"
}
Rancher
labels:
- "traefik.http.middlewares.example.stripprefix.prefixes=/foobar"
- "traefik.http.middlewares.example.stripprefix.forceSlash=false"
http:
middlewares:
example:
stripPrefix:
prefixes:
- "/foobar"
File (TOML)