traefik/docs/content/middlewares/http/stripprefixregex.md

74 lines
2.3 KiB
Markdown
Raw Normal View History

---
title: "Traefik StripPrefixRegex Documentation"
description: "In Traefik Proxy's HTTP middleware, StripPrefixRegex removes prefixes from paths before forwarding requests, using regex. Read the technical documentation."
---
2019-06-18 10:20:04 +00:00
# StripPrefixRegex
Removing Prefixes From the Path Before Forwarding the Request (Using a Regex)
{: .subtitle }
2019-04-08 15:14:08 +00:00
Remove the matching prefixes from the URL path.
## Configuration Examples
2023-05-10 13:28:05 +00:00
```yaml tab="Docker & Swarm"
2019-04-08 15:14:08 +00:00
labels:
2019-09-23 15:00:06 +00:00
- "traefik.http.middlewares.test-stripprefixregex.stripprefixregex.regex=/foo/[a-z0-9]+/[0-9]+/"
2019-04-08 15:14:08 +00:00
```
```yaml tab="Kubernetes"
2023-03-20 14:38:08 +00:00
apiVersion: traefik.io/v1alpha1
2019-04-08 15:14:08 +00:00
kind: Middleware
metadata:
name: test-stripprefixregex
spec:
2019-06-18 07:50:05 +00:00
stripPrefixRegex:
2019-09-02 08:52:04 +00:00
regex:
2019-09-23 15:00:06 +00:00
- "/foo/[a-z0-9]+/[0-9]+/"
2019-04-08 15:14:08 +00:00
```
2019-10-15 15:34:08 +00:00
```yaml tab="Consul Catalog"
- "traefik.http.middlewares.test-stripprefixregex.stripprefixregex.regex=/foo/[a-z0-9]+/[0-9]+/"
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
http:
middlewares:
test-stripprefixregex:
stripPrefixRegex:
2019-09-02 08:52:04 +00:00
regex:
2019-09-23 15:00:06 +00:00
- "/foo/[a-z0-9]+/[0-9]+/"
2019-04-08 15:14:08 +00:00
```
```toml tab="File (TOML)"
[http.middlewares]
[http.middlewares.test-stripprefixregex.stripPrefixRegex]
regex = ["/foo/[a-z0-9]+/[0-9]+/"]
```
2019-04-08 15:14:08 +00:00
## Configuration Options
### General
2021-02-11 13:34:04 +00:00
The StripPrefixRegex middleware strips the matching path prefix and stores it in a `X-Forwarded-Prefix` header.
2019-04-08 15:14:08 +00:00
!!! tip
2021-02-11 13:34:04 +00:00
Use a `stripPrefixRegex` middleware if your backend listens on the root path (`/`) but should be exposed on a specific prefix.
2019-04-08 15:14:08 +00:00
### `regex`
The `regex` option is the regular expression to match the path prefix from the request URL.
2021-02-11 13:34:04 +00:00
For instance, `/products` also matches `/products/shoes` and `/products/shirts`.
2019-04-08 15:14:08 +00:00
2021-02-11 13:34:04 +00:00
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).
!!! tip
Regular expressions and replacements can be tested using online tools such as [Go Playground](https://play.golang.org/p/mWU9p-wk2ru) or the [Regex101](https://regex101.com/r/58sIgx/2).
When defining a regular expression within YAML, any escaped character needs to be escaped twice: `example\.com` needs to be written as `example\\.com`.