Skip to content

docs: clarify description for redir directive #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
felixauringer wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −2
Open

docs: clarify description for redir directive #539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/docs/markdown/caddyfile/directives/redir.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,19 @@ redir [<matcher>] <to> [<code>]

- A positive integer in the `3xx` range, or `401`

- `temporary` for a temporary redirect (`302`, this is the default)
- `temporary` for a temporary redirect (`302 Found`, this is the default)

- `permanent` for a permanent redirect (`301`)
- `permanent` for a permanent redirect (`301 Moved Permanently`)

- `html` to use an HTML document to perform the redirect (useful for redirecting browsers but not API clients)

- A placeholder with a status code value


Note that both `temporary` and `permanent` allow the user agent to change the method (e.g. from `POST` to `GET`).
The status codes `307 Temporary Redirect` and `308 Permanent Redirect` should be used if the method must be the same in the second request.
Caddy uses `308` as the status code in its automatic HTTP to HTTPS redirects.


## Examples

Expand Down