redir

Issues an HTTP redirect to the client.

This directive implies that a matched request is to be rejected as-is, and the client should try again at a different URL. For that reason, its directive order is very early.

Syntax

redir [<matcher>] <to> [<code>]

• <to> is the target location. Becomes the response's Location header .

• <code> is the HTTP status code to use for the redirect. Can be:

  • A positive integer in the 3xx range, or 401

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

  • 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

Redirect all requests to https://example.com:

www.example.com {
	redir https://example.com
}

Same, but preserve the existing URI by appending the {uri} placeholder:

www.example.com {
	redir https://example.com{uri}
}

Same, but permanent:

www.example.com {
	redir https://example.com{uri} permanent
}

Redirect your old /about-us page to your new /about page:

example.com {
	redir /about-us /about
	reverse_proxy localhost:9000
}