error-pages

<p align="center"> <a href="https://github.com/tarampampam/error-pages#readme"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://socialify.git.ci/tarampampam/error-pages/image?description=1&font=Raleway&forks=1&issues=1&logo=https%3A%2F%2Fhsto.org%2Fwebt%2Frm%2F9y%2Fww%2Frm9ywwx3gjv9agwkcmllhsuyo7k.png&owner=1&pulls=1&pattern=Solid&stargazers=1&theme=Dark"> <img align="center" src="https://socialify.git.ci/tarampampam/error-pages/image?description=1&font=Raleway&forks=1&issues=1&logo=https%3A%2F%2Fhsto.org%2Fwebt%2Frm%2F9y%2Fww%2Frm9ywwx3gjv9agwkcmllhsuyo7k.png&owner=1&pulls=1&pattern=Solid&stargazers=1&theme=Light"> </picture> </a> </p> <p align="center"> <a href="#"><img src="https://img.shields.io/github/go-mod/go-version/tarampampam/error-pages?longCache=true&label=&logo=go&logoColor=white&style=flat-square" alt="" /></a> <a href="https://github.com/tarampampam/error-pages/actions"><img src="https://img.shields.io/github/actions/workflow/status/tarampampam/error-pages/tests.yml?branch=master&maxAge=30&label=tests&logo=github&style=flat-square" alt="" /></a> <a href="https://github.com/tarampampam/error-pages/actions"><img src="https://img.shields.io/github/actions/workflow/status/tarampampam/error-pages/release.yml?maxAge=30&label=release&logo=github&style=flat-square" alt="" /></a> <a href="https://hub.docker.com/r/tarampampam/error-pages"><img src="https://img.shields.io/docker/pulls/tarampampam/error-pages.svg?maxAge=30&label=pulls&logo=docker&logoColor=white&style=flat-square" alt="" /></a> <a href="https://hub.docker.com/r/tarampampam/error-pages"><img src="https://img.shields.io/docker/image-size/tarampampam/error-pages/latest?maxAge=30&label=size&logo=docker&logoColor=white&style=flat-square" alt="" /></a> <a href="https://github.com/tarampampam/error-pages/blob/master/LICENSE"><img src="https://img.shields.io/github/license/tarampampam/error-pages.svg?maxAge=30&style=flat-square" alt="" /></a> </p>

One day, you might want to replace the standard error pages of your HTTP server or K8S cluster with something more original and attractive. That's why this repository was created :) It contains:

• A simple error page generator written in Go
• Single-page error templates (themes) with various designs (located in the templates directory) that you can customize as you wish
• A fast and lightweight HTTP server is available as a single binary file and Docker image. It includes built-in error page templates from this repository. You don't need anything except the compiled binary file or Docker image
• Pre-generated error pages (sources can be found here, and the demo is always accessible here)

🔥 Features List

• HTTP server written in Go, utilizing the extremely fast FastHTTP and in-memory caching
  • Respects the Content-Type HTTP header (and X-Format) value, responding with the corresponding format (supported formats: json, xml, and plaintext)
  • Error pages are configured to be excluded from search engine indexing (using meta tags and HTTP headers) to prevent SEO issues on your website
  • HTML content (including CSS, SVG, and JS) is minified on the fly
  • Logs written in json format
  • Contains a health check endpoint (/healthz)
  • Consumes very few resources and is suitable for use in resource-constrained environments
• Lightweight Docker image, distroless, and uses an unprivileged user by default
• Go-template tags are allowed in the templates
• Ready for integration with Traefik, [Ingress-nginx][ingress-nginx], and more
• Error pages can be embedded into your own Docker image with nginx in a few simple steps
• Fully configurable
• Distributed as a Docker image and compiled binary files
• Localized HTML error pages (🇺🇸, 🇫🇷, 🇺🇦, 🇷🇺, 🇵🇹, 🇳🇱, 🇩🇪, 🇪🇸, 🇨🇳, 🇮🇩, 🇵🇱, 🇰🇷) - translation process described here - other translations are welcome!

🧩 Install

Download the latest binary file for your OS/architecture from the releases page or use our Docker image:

Registry	Image
GitHub Container Registry	ghcr.io/tarampampam/error-pages
Docker Hub (mirror)	tarampampam/error-pages

[!IMPORTANT] Using the latest tag for the Docker image is highly discouraged due to potential backward-incompatible changes during major upgrades. Please use tags in the X.Y.Z format.

💣 Or you can also download the already rendered error pages pack as a zip or tar.gz archive.

🪂 Templates (themes)

The following templates are built-in and available for use without any additional setup:

[!NOTE] The cats template is the only one of those that fetches resources (the actual cat pictures) from external servers - all other templates are self-contained.

<table> <thead> <tr> <th>Template</th> <th>Preview</th> </tr> </thead> <tbody> <tr> <td align="center"> <code>app-down</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fapp-down.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/app-down/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/4e668a56-a4c4-47cd-ac4d-b6b45db54ab8"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/ad4b4fd7-7c7b-4bdc-a6b6-44f9ba7f77ca"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>cats</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fcats.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/cats/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/5689880b-f770-406c-81dd-2d28629e6f2e"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/056cd00e-bc9a-4120-8325-310d7b0ebd1b"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>connection</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fconnection.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/connection/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/3f03dc1b-c1ee-4a91-b3d7-e3b93c79020e"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/099ecc2d-e724-4d9c-b5ed-66ddabd71139"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>ghost</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fghost.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/ghost/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/714482ab-f8c1-4455-8ae8-b2ae78f7a2c6"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/f253dfe7-96a0-4e96-915b-d4c544d4a237"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>hacker-terminal</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fhacker-terminal.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/hacker-terminal/404.html"> <picture> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/c197fc35-0844-43d0-9830-82440cee4559"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>l7</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fl7.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/l7/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/18e43ea3-6389-4459-be41-0fc6566a073f"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/05f26669-94ec-40ce-8d67-a199cde54202"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>lost-in-space</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Flost-in-space.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/lost-in-space/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/debf87c0-6f27-41a8-b141-ee3464cbd6cc"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/c347e63d-13a7-46d4-81b9-b25266819a1d"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>noise</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fnoise.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/noise/404.html"> <picture> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/4cc5c3bd-6ebb-4e96-bee8-02d4ad4e7266"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>orient</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Forient.json&query=%24.count&label=used%20times" alt="used times"> </picture> </td> <td> <a href="https://tarampampam.github.io/error-pages/orient/404.html"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tarampampam/error-pages/assets/7326800/bc2b0dad-c32c-4628-98f6-e3eab61dd1f2"> <img align="center" src="https://github.com/tarampampam/error-pages/assets/7326800/8fc0a7ea-694d-49ce-bb50-3ea032d52d1e"> </picture> </a> </td> </tr> <tr> <td align="center"> <code>shuffle</code><br/><br/> <picture> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Ferror-pages.goatcounter.com%2Fcounter%2F%2Fuse-template%2Fshuffle.json&query=%24.count&label=used%20times" alt="used times"> </picture>