<!--GENERATED:CLI_DOCS--> <!-- Documentation inside this block generated by github.com/urfave/cli; DO NOT EDIT --> ## CLI interface Usage: ```bash $ error-pages [GLOBAL FLAGS] [COMMAND] [COMMAND FLAGS] [ARGUMENTS...] ``` Global flags: | Name | Description | Default value | Environment variables | |--------------------|---------------------------------------------|:-------------:|:---------------------:| | `--log-level="…"` | logging level (debug/info/warn/error/fatal) | `info` | `LOG_LEVEL` | | `--log-format="…"` | logging format (console/json) | `console` | `LOG_FORMAT` | ### `serve` command (aliases: `s`, `server`, `http`) Start HTTP server. Usage: ```bash $ error-pages [GLOBAL FLAGS] serve [COMMAND FLAGS] [ARGUMENTS...] ``` The following flags are supported: | Name | Description | Default value | Environment variables | |------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------:|:-------------------------:| | `--listen="…"` (`-l`) | IP (v4 or v6) address to listen on | `0.0.0.0` | `LISTEN_ADDR` | | `--port="…"` (`-p`) | TCP port number | `8080` | `LISTEN_PORT` | | `--add-template="…"` | to add a new template, provide the path to the file using this flag (the filename without the extension will be used as the template name) | `[]` | *none* | | `--add-http-code="…"` | to add a new HTTP status code, provide the code and its message/description using this flag (the format should be '%code%=%message%/%description%'; the code may contain a wildcard '*' to cover multiple codes at once, for example, '4**' will cover all 4xx codes, unless a more specific code was described previously) | `map[]` | *none* | | `--json-format="…"` | override the default error page response in JSON format (Go templates are supported) | | `RESPONSE_JSON_FORMAT` | | `--xml-format="…"` | override the default error page response in XML format (Go templates are supported) | | `RESPONSE_XML_FORMAT` | | `--template-name="…"` (`-t`) | name of the template to use for rendering error pages | `template-1` | `TEMPLATE_NAME` | | `--disable-l10n` | disable localization of error pages (if the template supports localization) | `false` | `DISABLE_L10N` | | `--default-error-page="…"` | the code of the default (index page, when a code is not specified) error page to render | `404` | `DEFAULT_ERROR_PAGE` | | `--send-same-http-code` | the HTTP response should have the same status code as the requested error page (by default, every response with an error page will have a status code of 200) | `false` | `SEND_SAME_HTTP_CODE` | | `--show-details` | show request details in the error page response (if supported by the template) | `false` | `SHOW_DETAILS` | | `--proxy-headers="…"` | listed here HTTP headers will be proxied from the original request to the error page response (comma-separated list) | `X-Request-Id,X-Trace-Id,X-Amzn-Trace-Id` | `PROXY_HTTP_HEADERS` | | `--rotation-mode="…"` | templates automatic rotation mode (disabled/random-on-startup/random-on-each-request/random-daily/random-hourly) | `disabled` | `TEMPLATES_ROTATION_MODE` | ### `healthcheck` command (aliases: `chk`, `health`, `check`) Health checker for the HTTP server. The use case - docker health check. Usage: ```bash $ error-pages [GLOBAL FLAGS] healthcheck [COMMAND FLAGS] [ARGUMENTS...] ``` The following flags are supported: | Name | Description | Default value | Environment variables | |---------------------|-----------------|:-------------:|:---------------------:| | `--port="…"` (`-p`) | TCP port number | `8080` | `LISTEN_PORT` | <!--/GENERATED:CLI_DOCS--> <!-- <p align="center"> <a href="https://github.com/tarampampam/error-pages#readme"><img 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=Dark" alt="banner" width="100%" /></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://codecov.io/gh/tarampampam/error-pages"><img src="https://img.shields.io/codecov/c/github/tarampampam/error-pages/master.svg?maxAge=30&label=&logo=codecov&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> <p align="center"><sup> 22 feb. 2022 - ⚡ Our Docker image was downloaded <strong>one MILLION times</strong> from the docker hub! ⚡<br/> 10 apr. 2023 - ⚡ <strong>Two million times</strong> from the docker hub and <strong>one million</strong> from the ghcr! ⚡ </sup></p> One day you may want to replace the standard error pages of your HTTP server with something more original and pretty. That's what this repository was created for :) It contains: - Simple error pages generator, written in Go - Single-page error page templates with different designs (located in the [templates](https://github.com/tarampampam/error-pages/tree/master/templates) directory) - Fast and lightweight HTTP server - Already generated error pages (sources can be [found here][preview-sources], the **demonstration** is always accessible [here][preview-demo]) ## 🔥 Features list - HTTP server written in Go, with the extremely fast [FastHTTP][fasthttp] under the hood - Respects the `Content-Type` HTTP header (and `X-Format`) value and responds with the corresponding format (supported formats are `json` and `xml`) - Writes logs in `json` format - Contains healthcheck endpoint (`/healthz`) - Contains metrics endpoint (`/metrics`) in Prometheus format - Lightweight docker image _(~4.6Mb compressed size)_, distroless and uses the unleveled user by default - [Go-template](https://pkg.go.dev/text/template) tags are allowed in the templates - Ready for integration with [Traefik][traefik] ([error pages customization](https://doc.traefik.io/traefik/middlewares/http/errorpages/)) and [Ingress-nginx][ingress-nginx] - Error pages can be [embedded into your own `nginx`][wiki-usage-with-nginx] docker image - Fully configurable (take a look at the [configuration file](https://github.com/tarampampam/error-pages/blob/master/error-pages.yml) and [project Wiki][wiki]) - Distributed using docker image and compiled binary files - Localized (🇺🇸, 🇫🇷, 🇺🇦, 🇷🇺, 🇵🇹, 🇳🇱, 🇩🇪, 🇪🇸, 🇨🇳, 🇮🇩, 🇵🇱) HTML error pages (translation process [described here](https://github.com/tarampampam/error-pages/tree/master/l10n) - other translations are welcome!) ## 🧩 Install Download the latest binary file for your os/arch from the [releases page][releases] or use our docker image: | Registry | Image | |-----------------------------------|-----------------------------------| | [Docker Hub][docker-hub] | `tarampampam/error-pages` | | [GitHub Container Registry][ghcr] | `ghcr.io/tarampampam/error-pages` | > Using the `latest` tag for the docker image is highly discouraged because of possible backward-incompatible changes during **major** upgrades. Please, use tags in `X.Y.Z` format 💣 **Or** you can download **already rendered** error pages pack as a [zip][pages-pack-zip] or [tar.gz][pages-pack-tar-gz] archive. [pages-pack-zip]:https://github.com/tarampampam/error-pages/zipball/gh-pages/ [pages-pack-tar-gz]:https://github.com/tarampampam/error-pages/tarball/gh-pages/ ## 🛠 Usage Please, take a look at [our Wiki][wiki] for the common usage stories: - [HTTP server][wiki-http-server] (routes, formats, flags and environment variables) - [Pages generator][wiki-generator] (build your own error page set) - [Static error pages][wiki-static-error-pages] (extract generated static error pages from the docker image) - [Usage with nginx][wiki-usage-with-nginx] (include our error pages into an image with nginx) - [Usage with Traefik and local Docker Compose][wiki-traefik-docker-compose] (it's a good starting point for the tests) - [Usage with Traefik and Docker Swarm][wiki-traefik-swarm] - [Kubernetes & ingress nginx][wiki-k8s-ingress-nginx] [wiki]:https://github.com/tarampampam/error-pages/wiki [wiki-http-server]:https://github.com/tarampampam/error-pages/wiki/HTTP-server [wiki-generator]:https://github.com/tarampampam/error-pages/wiki/Generator [wiki-static-error-pages]:https://github.com/tarampampam/error-pages/wiki/Static-error-pages [wiki-usage-with-nginx]:https://github.com/tarampampam/error-pages/wiki/Usage-with-nginx [wiki-traefik-swarm]:https://github.com/tarampampam/error-pages/wiki/Traefik-(docker-swarm) [wiki-traefik-docker-compose]:https://github.com/tarampampam/error-pages/wiki/Traefik-(docker-compose) [wiki-k8s-ingress-nginx]:https://github.com/tarampampam/error-pages/wiki/Kubernetes-&-ingress-nginx ## 🦾 Performance Used hardware: - Intel® Core™ i7-10510U CPU @ 1.80GHz × 8 - 16 GiB RAM ```shell $ ulimit -aH | grep file -f: file size (blocks) unlimited -c: core file size (blocks) unlimited -n: file descriptors 1048576 -x: file locks unlimited $ docker run --rm -p "8080:8080/tcp" -e "SHOW_DETAILS=true" error-pages:local # in separate terminal $ wrk --timeout 1s -t12 -c400 -d30s -s ./test/wrk/request.lua http://127.0.0.1:8080/ Running 30s test @ http://127.0.0.1:8080/ 12 threads and 400 connections Thread Stats Avg Stdev Max +/- Stdev Latency 10.84ms 7.89ms 135.91ms 79.36% Req/Sec 3.23k 785.11 6.30k 70.04% 1160567 requests in 30.10s, 4.12GB read Requests/sec: 38552.04 Transfer/sec: 140.23MB ``` <details> <summary>FS & memory usage stats during the test</summary> <p align="center"> <img src="https://hsto.org/webt/ts/w-/lz/tsw-lznvru0ngjneiimkwq7ysyc.png" alt="" /> </p> </details> ## 🪂 Templates | Name | Preview | |:-----------------:|:------------------------------------------------------------------:| | `ghost` | [![ghost][ghost-screen]][ghost-link] | | `l7-light` | [![l7-light][l7-light-screen]][l7-light-link] | | `l7-dark` | [![l7-dark][l7-dark-screen]][l7-dark-link] | | `shuffle` | [![shuffle][shuffle-screen]][shuffle-link] | | `noise` | [![noise][noise-screen]][noise-link] | | `hacker-terminal` | [![hacker-terminal][hacker-terminal-screen]][hacker-terminal-link] | | `cats` | [![cats][cats-screen]][cats-link] | | `lost-in-space` | [![lost-in-space][lost-in-space-screen]][lost-in-space-link] | | `app-down` | [![app-down][app-down-screen]][app-down-link] | | `connection` | [![connection][connection-screen]][connection-link] | | `matrix` | [![matrix][matrix-screen]][matrix-link] | | `orient` | [![orient][orient-screen]][orient-link] | > Note: `noise` template highly uses the CPU, be careful [ghost-screen]:https://hsto.org/webt/oj/cl/4k/ojcl4ko_cvusy5xuki6efffzsyo.gif [ghost-link]:https://tarampampam.github.io/error-pages/ghost/404.html [l7-light-screen]:https://hsto.org/webt/hx/ca/mm/hxcammfm7qjmogtvsjxcidgf7c8.png [l7-light-link]:https://tarampampam.github.io/error-pages/l7-light/404.html [l7-dark-screen]:https://hsto.org/webt/s1/ih/yr/s1ihyrqs_y-sgraoimfhk6ypney.png [l7-dark-link]:https://tarampampam.github.io/error-pages/l7-dark/404.html [shuffle-screen]:https://hsto.org/webt/7w/rk/3m/7wrk3mrzz3y8qfqwovmuvacu-bs.gif [shuffle-link]:https://tarampampam.github.io/error-pages/shuffle/404.html [noise-screen]:https://hsto.org/webt/42/oq/8y/42oq8yok_i-arrafjt6hds_7ahy.gif [noise-link]:https://tarampampam.github.io/error-pages/noise/404.html [hacker-terminal-screen]:https://hsto.org/webt/5s/l0/p1/5sl0p1_ud_nalzjzsj5slz6dfda.gif [hacker-terminal-link]:https://tarampampam.github.io/error-pages/hacker-terminal/404.html [cats-screen]:https://hsto.org/webt/_g/y-/ke/_gy-keqinz-3867jbw36v37-iwe.jpeg [cats-link]:https://tarampampam.github.io/error-pages/cats/404.html [lost-in-space-screen]:https://hsto.org/webt/lf/ln/x8/lflnx8fuy4rofxju34ttskijdsu.gif [lost-in-space-link]:https://tarampampam.github.io/error-pages/lost-in-space/404.html [app-down-screen]:https://habrastorage.org/webt/j2/la/fj/j2lafjvu_xjflzrvhiixobxy_ca.png [app-down-link]:https://tarampampam.github.io/error-pages/app-down/404.html [connection-screen]:https://hsto.org/webt/x4/ah/jb/x4ahjboo4-arm3bxpaash_sflmw.png [connection-link]:https://tarampampam.github.io/error-pages/connection/404.html [matrix-screen]:https://hsto.org/webt/ng/tf/oi/ngtfoiolvmq6hf15kimcxmhprhk.gif [matrix-link]:https://tarampampam.github.io/error-pages/matrix/404.html [orient-screen]:https://hsto.org/webt/pz/eu/v_/pzeuv_lyeqr0xpusa4zfrtgk7sa.png [orient-link]:https://tarampampam.github.io/error-pages/orient/404.html ## 🦾 Contributors I want to say a big thank you to everyone who contributed to this project: [![contributors](https://contrib.rocks/image?repo=tarampampam/error-pages)][contributors] [contributors]:https://github.com/tarampampam/error-pages/graphs/contributors ## 📰 Changes log [![Release date][badge-release-date]][releases] [![Commits since latest release][badge-commits]][commits] Changes log can be [found here][changelog]. ## 👾 Support [![Issues][badge-issues]][issues] [![Issues][badge-prs]][prs] If you find any bugs in the project, please [create an issue][new-issue] in the current repository. ## 📖 License This is open-sourced software licensed under the [MIT License][license]. [badge-release]:https://img.shields.io/github/release/tarampampam/error-pages.svg?maxAge=30 [badge-release-date]:https://img.shields.io/github/release-date/tarampampam/error-pages.svg?maxAge=180 [badge-commits]:https://img.shields.io/github/commits-since/tarampampam/error-pages/latest.svg?maxAge=45 [badge-issues]:https://img.shields.io/github/issues/tarampampam/error-pages.svg?maxAge=45 [badge-prs]:https://img.shields.io/github/issues-pr/tarampampam/error-pages.svg?maxAge=45 [docker-hub]:https://hub.docker.com/r/tarampampam/error-pages [docker-hub-tags]:https://hub.docker.com/r/tarampampam/error-pages/tags [license]:https://github.com/tarampampam/error-pages/blob/master/LICENSE [releases]:https://github.com/tarampampam/error-pages/releases [commits]:https://github.com/tarampampam/error-pages/commits [changelog]:https://github.com/tarampampam/error-pages/blob/master/CHANGELOG.md [issues]:https://github.com/tarampampam/error-pages/issues [new-issue]:https://github.com/tarampampam/error-pages/issues/new/choose [prs]:https://github.com/tarampampam/error-pages/pulls [ghcr]:https://github.com/users/tarampampam/packages/container/package/error-pages [fasthttp]:https://github.com/valyala/fasthttp [preview-sources]:https://github.com/tarampampam/error-pages/tree/gh-pages [preview-demo]:https://tarampampam.github.io/error-pages/ [traefik]:https://github.com/traefik/traefik [ingress-nginx]:https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx -->