ErrorPage

It Has Never Been Easier to Say That Something Went Wrong

ErrorPages

The ErrorPage middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes.

Important

The error page itself is not hosted by Traefik.

Configuration Examples

Docker

  1. # Dynamic Custom Error Page for 5XX Status Code
  2. labels:
  3.   - "traefik.http.middlewares.test-errorpage.errors.status=500-599"
  4.   - "traefik.http.middlewares.test-errorpage.errors.service=serviceError"
  5.   - "traefik.http.middlewares.test-errorpage.errors.query=/{status}.html"

Kubernetes

  1. apiVersion: traefik.containo.us/v1alpha1
  2. kind: Middleware
  3. metadata:
  4.   name: test-errorpage
  5. spec:
  6.   errors:
  7.     status:
  8.       - "500-599"
  9.     query: /{status}.html
  10.     service:
  11.       name: whoami
  12.       port: 80

Consul Catalog

  1. # Dynamic Custom Error Page for 5XX Status Code
  2. - "traefik.http.middlewares.test-errorpage.errors.status=500-599"
  3. - "traefik.http.middlewares.test-errorpage.errors.service=serviceError"
  4. - "traefik.http.middlewares.test-errorpage.errors.query=/{status}.html"

Marathon

  1. "labels": {
  2.   "traefik.http.middlewares.test-errorpage.errors.status": "500-599",
  3.   "traefik.http.middlewares.test-errorpage.errors.service": "serviceError",
  4.   "traefik.http.middlewares.test-errorpage.errors.query": "/{status}.html"
  5. }

Rancher

  1. # Dynamic Custom Error Page for 5XX Status Code
  2. labels:
  3.   - "traefik.http.middlewares.test-errorpage.errors.status=500-599"
  4.   - "traefik.http.middlewares.test-errorpage.errors.service=serviceError"
  5.   - "traefik.http.middlewares.test-errorpage.errors.query=/{status}.html"

File (YAML)

  1. # Custom Error Page for 5XX
  2. http:
  3.   middlewares:
  4.     test-errorpage:
  5.       errors:
  6.         status:
  7.           - "500-599"
  8.         service: serviceError
  9.         query: "/{status}.html"
  11.   services:
  12.     # ... definition of error-handler-service and my-service

File (TOML)

  1. # Custom Error Page for 5XX
  2. [http.middlewares]
  3.   [http.middlewares.test-errorpage.errors]
  4.     status = ["500-599"]
  5.     service = "serviceError"
  6.     query = "/{status}.html"
  8. [http.services]
  9.   # ... definition of error-handler-service and my-service

In this example, the error page URL is based on the status code (query=/{status}.html).

Configuration Options

status

The status option defines which status or range of statuses should result in an error page.

The status code ranges are inclusive (500-599 will trigger with every code between 500 and 599, 500 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 (500-599), or a combination of the two (404,418,500-599).

service

The service that will serve the new requested error page.

In Kubernetes, you need to reference a Kubernetes Service instead of a Traefik service.

query

The URL for the error page (hosted by service). You can use the {status} variable in the query option in order to insert the status code in the URL.