traefik/docs/content/middlewares/redirectregex.md

86 lines
2.5 KiB
Markdown
Raw Normal View History

2019-04-08 15:14:08 +00:00
# RedirectRegex
Redirecting the Client to a Different Location
{: .subtitle }
`TODO: add schema`
RegexRedirect redirect a request from an url to another with regex matching and replacement.
## Configuration Examples
2019-04-03 12:32:04 +00:00
```yaml tab="Docker"
# Redirect with domain replacement
2019-09-09 08:36:08 +00:00
# Note: all dollar signs need to be doubled for escaping.
2019-04-03 12:32:04 +00:00
labels:
- "traefik.http.middlewares.test-redirectregex.redirectregex.regex=^http://localhost/(.*)"
- "traefik.http.middlewares.test-redirectregex.redirectregex.replacement=http://mydomain/$${1}"
2019-04-03 12:32:04 +00:00
```
```yaml tab="Kubernetes"
# Redirect with domain replacement
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
name: test-redirectregex
spec:
redirectRegex:
regex: ^http://localhost/(.*)
replacement: http://mydomain/${1}
2019-04-03 12:32:04 +00:00
```
```json tab="Marathon"
"labels": {
"traefik.http.middlewares.test-redirectregex.redirectregex.regex": "^http://localhost/(.*)",
"traefik.http.middlewares.test-redirectregex.redirectregex.replacement": "http://mydomain/${1}"
}
```
2019-04-08 15:14:08 +00:00
```yaml tab="Rancher"
# Redirect with domain replacement
2019-09-09 08:36:08 +00:00
# Note: all dollar signs need to be doubled for escaping.
2019-04-08 15:14:08 +00:00
labels:
- "traefik.http.middlewares.test-redirectregex.redirectregex.regex=^http://localhost/(.*)"
2019-09-09 08:36:08 +00:00
- "traefik.http.middlewares.test-redirectregex.redirectregex.replacement=http://mydomain/$${1}"
2019-04-08 15:14:08 +00:00
```
2019-07-22 07:58:04 +00:00
```toml tab="File (TOML)"
2019-04-03 12:32:04 +00:00
# Redirect with domain replacement
[http.middlewares]
2019-07-01 09:30:05 +00:00
[http.middlewares.test-redirectregex.redirectRegex]
2019-04-03 12:32:04 +00:00
regex = "^http://localhost/(.*)"
replacement = "http://mydomain/${1}"
2019-04-03 12:32:04 +00:00
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
# Redirect with domain replacement
http:
middlewares:
test-redirectregex:
redirectRegex:
regex: "^http://localhost/(.*)"
replacement: "http://mydomain/${1}"
2019-07-22 07:58:04 +00:00
```
## Configuration Options
2019-04-03 12:32:04 +00:00
### `permanent`
Set the `permanent` option to `true` to apply a permanent redirection.
2019-04-03 12:32:04 +00:00
### `regex`
2019-07-01 09:30:05 +00:00
The `regex` option is the regular expression to match and capture elements from the request URL.
!!! warning
Care should be taken when defining replacement expand variables: `$1x` is equivalent to `${1x}`, not `${1}x` (see [Regexp.Expand](https://golang.org/pkg/regexp/#Regexp.Expand)), so use `${1}` syntax.
!!! 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).
2019-04-03 12:32:04 +00:00
### `replacement`
The `replacement` option defines how to modify the URL to have the new target URL.