Error Pages
The Errors middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes.
The error page itself is not hosted by Traefik.
Configuration Options
status
Field | Description |
---|---|
status | The status option defines which status or range of statuses should result in an error page. |
The status code ranges are inclusive (505-599
will trigger with every code between 505
and 599
, 505
and 599
included).
You can define either a status code as a number (500
), as multiple comma-separated numbers (500,502
), as ranges by separating two codes with a dash (505-599
),
or a combination of the two (404,418,505-599
).
The comma-separated syntax is only available for label-based providers.
The examples above demonstrate which syntax is appropriate for each provider.
service
Field | Description |
---|---|
service | The Kubernetes Service that will serve the new requested error page. |
By default, the client Host
header value is forwarded to the configured error service.
To forward the Host
value corresponding to the configured error service URL, the passHostHeader option must be set to false
.
query
Field | Description |
---|---|
query | The URL for the error page (hosted by service ). |
There are multiple variables that can be placed in the query
option to insert values in the URL.
The table below lists all the available variables and their associated values.
Variable | Value |
---|---|
{status} | The response status code. |
{url} | The escaped request URL. |
Example
apiVersion: traefik.io/v1alpha1
kind: Middleware
metadata:
name: test-errors
spec:
errors:
status:
- "500"
- "501"
- "503"
- "505-599"
query: /{status}.html
service:
name: whoami
port: 80