caddy-website/src/docs/markdown/caddyfile/directives/uri.md

66 lines
2.4 KiB
Markdown
Raw Normal View History

2020-03-21 21:03:55 -06:00
---
title: uri (Caddyfile directive)
---
# uri
Manipulates a request's URI. It can strip path prefix/suffix or replace substrings on the whole URI.
This directive is distinct from [`rewrite`](rewrite) in that `uri` _partially_ changes the URI, rather than setting it to something completely different as `rewrite` does. While `rewrite` is treated specially as an internal redirect, `uri` is just another handler.
## Syntax
Multiple different operations are supported:
```caddy-d
uri [<matcher>] strip_prefix <target>
uri [<matcher>] strip_suffix <target>
uri [<matcher>] replace <target> <replacement> [<limit>]
uri [<matcher>] path_regexp <target> <replacement>
2020-03-21 21:03:55 -06:00
```
- The first (non-matcher) argument specifies the operation:
- **strip_prefix** strips a prefix from the path, if it has the prefix.
- **strip_suffix** strips a suffix from the path, if it has the suffix.
- **replace** performs a substring replacement across the whole URI.
- **path_regexp** performs a regular expression replacement on the path portion of the URI.
2020-03-21 21:03:55 -06:00
- **&lt;target&gt;** is the prefix, suffix, or search string/regular expression. If a prefix, the leading forward slash may be omitted, since paths always start with a forward slash.
- **&lt;replacement&gt;** is the replacement string (only valid with `replace` and `path_regexp`). Supports using capture groups with `$name` or `${name}` syntax, or with a number for the index, such as `$1`. See the [Go documentation](https://golang.org/pkg/regexp/#Regexp.Expand) for details.
2020-03-21 21:03:55 -06:00
- **&lt;limit&gt;** is an optional limit to the maximum number of replacements (only valid with `replace`).
## Similar directives
Some other directives can also manipulate the request URI.
- [`rewrite`](rewrite) will change the entire path and query to a new value, instead of doing a partial change like `uri` does.
- [`handle_path`](handle_path) does the same as [`handle`](handle), but it strips a prefix from the request before running its handlers. Can be used instead of `uri strip_prefix` to save a line of config in many situations.
2020-03-21 21:03:55 -06:00
## Examples
2020-03-22 16:14:17 -06:00
Strip `/api` from the beginning of all request paths:
2020-03-21 21:03:55 -06:00
```caddy-d
2020-03-22 16:14:17 -06:00
uri strip_prefix /api
2020-03-21 21:03:55 -06:00
```
Strip `.php` from the end of all request paths:
```caddy-d
2020-03-21 21:03:55 -06:00
uri strip_suffix .php
```
Replace "/docs/" with "/v1/docs/" in any request URI:
```caddy-d
2020-03-21 21:03:55 -06:00
uri replace /docs/ /v1/docs/
```
Collapse all repeated slashes in the request path (but not the request query) to a single slash:
```caddy-d
uri path_regexp /{2,} /
```