mirror of
https://github.com/tarampampam/error-pages.git
synced 2024-08-30 18:22:40 +00:00
147 lines
4.8 KiB
Markdown
147 lines
4.8 KiB
Markdown
<p align="center">
|
|
<img src="https://hsto.org/webt/rg/ys/c3/rgysc33oc7jiufdzmwrkohpmef8.png" width="94" alt="" />
|
|
</p>
|
|
|
|
# HTTP's error pages in :whale: image
|
|
|
|
[![Build Status][badge_build_status]][link_build_status]
|
|
[![Image size][badge_size_latest]][link_docker_hub]
|
|
[![License][badge_license]][link_license]
|
|
|
|
This repository contains:
|
|
|
|
- A very simple [generator](./bin/generator.js) _(`nodejs`)_ for HTTP error pages _(like `404: Not found`)_ with different templates supports
|
|
- Dockerfile for [docker image][link_docker_hub] with generated pages and `nginx` as web server
|
|
|
|
## Development
|
|
|
|
> For project development we use `docker-ce` + `docker-compose`. Make sure you have them installed.
|
|
|
|
Install `nodejs` dependencies:
|
|
|
|
```bash
|
|
$ make install
|
|
```
|
|
|
|
If you want to generate error pages on your machine _(after that look into output directory)_:
|
|
|
|
```bash
|
|
$ make gen
|
|
```
|
|
|
|
If you want to preview the pages using the Docker image:
|
|
|
|
```bash
|
|
$ make preview
|
|
```
|
|
|
|
Can be used for [Traefik error pages customization](https://docs.traefik.io/middlewares/errorpages/).
|
|
|
|
## Usage
|
|
|
|
Generated error pages in our [docker image][link_docker_hub] permanently located in directory `/opt/html/%THEME_NAME%`.
|
|
|
|
#### Supported environment variables
|
|
|
|
Name | Description
|
|
--------------- | -----------
|
|
`TEMPLATE_NAME` | "default" pages template _(allows to use error pages without passing theme name in URL - `http://127.0.0.1/500.html` instead `http://127.0.0.1/ghost/500.html`)_
|
|
|
|
### HTTP server for error pages serving only
|
|
|
|
Execute in your shell:
|
|
|
|
```bash
|
|
$ docker run --rm -p "8082:8080" tarampampam/error-pages
|
|
```
|
|
|
|
And open in your browser `http://127.0.0.1:8082/ghost/400.html`.
|
|
|
|
### Custom error pages for [nginx][link_nginx]
|
|
|
|
You can build your own docker image with `nginx` and our error pages:
|
|
|
|
```bash
|
|
# File `./nginx.conf`
|
|
|
|
server {
|
|
listen 80;
|
|
server_name localhost;
|
|
|
|
error_page 401 /_error-pages/401.html;
|
|
error_page 403 /_error-pages/403.html;
|
|
error_page 404 /_error-pages/404.html;
|
|
error_page 500 /_error-pages/500.html;
|
|
error_page 502 /_error-pages/502.html;
|
|
error_page 503 /_error-pages/503.html;
|
|
|
|
location ^~ /_error-pages/ {
|
|
internal;
|
|
root /usr/share/nginx/errorpages;
|
|
}
|
|
|
|
location / {
|
|
root /usr/share/nginx/html;
|
|
index index.html index.htm;
|
|
}
|
|
}
|
|
```
|
|
|
|
```dockerfile
|
|
FROM nginx:1.18-alpine
|
|
|
|
COPY --chown=nginx \
|
|
./nginx.conf /etc/nginx/conf.d/default.conf
|
|
COPY --chown=nginx \
|
|
--from=tarampampam/error-pages:1.0.0 \
|
|
/opt/html/ghost /usr/share/nginx/errorpages/_error-pages
|
|
```
|
|
|
|
> More info about `error_page` directive can be [found here](http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
|
|
|
|
### Custom error pages for [Traefik][link_traefik]
|
|
|
|
Simple traefik service configuration for usage in [docker swarm][link_swarm] (**change with your needs**):
|
|
|
|
```yaml
|
|
# Work in progress
|
|
```
|
|
|
|
## Changes log
|
|
|
|
[![Release date][badge_release_date]][link_releases]
|
|
[![Commits since latest release][badge_commits_since_release]][link_commits]
|
|
|
|
Changes log can be [found here][link_changes_log].
|
|
|
|
## Support
|
|
|
|
[![Issues][badge_issues]][link_issues]
|
|
[![Issues][badge_pulls]][link_pulls]
|
|
|
|
If you will find any package errors, please, [make an issue][link_create_issue] in current repository.
|
|
|
|
## License
|
|
|
|
This is open-sourced software licensed under the [MIT License][link_license].
|
|
|
|
[badge_build_status]:https://img.shields.io/github/workflow/status/tarampampam/error-pages/tests/master
|
|
[badge_release_date]:https://img.shields.io/github/release-date/tarampampam/error-pages.svg?style=flat-square&maxAge=180
|
|
[badge_commits_since_release]:https://img.shields.io/github/commits-since/tarampampam/error-pages/latest.svg?style=flat-square&maxAge=180
|
|
[badge_issues]:https://img.shields.io/github/issues/tarampampam/error-pages.svg?style=flat-square&maxAge=180
|
|
[badge_pulls]:https://img.shields.io/github/issues-pr/tarampampam/error-pages.svg?style=flat-square&maxAge=180
|
|
[badge_license]:https://img.shields.io/github/license/tarampampam/error-pages.svg?longCache=true
|
|
[badge_size_latest]:https://img.shields.io/docker/image-size/tarampampam/error-pages/latest?maxAge=30
|
|
[link_releases]:https://github.com/tarampampam/error-pages/releases
|
|
[link_commits]:https://github.com/tarampampam/error-pages/commits
|
|
[link_changes_log]:https://github.com/tarampampam/error-pages/blob/master/CHANGELOG.md
|
|
[link_issues]:https://github.com/tarampampam/error-pages/issues
|
|
[link_pulls]:https://github.com/tarampampam/error-pages/pulls
|
|
[link_build_status]:https://travis-ci.org/tarampampam/error-pages
|
|
[link_create_issue]:https://github.com/tarampampam/error-pages/issues/new
|
|
[link_license]:https://github.com/tarampampam/error-pages/blob/master/LICENSE
|
|
[link_docker_hub]:https://hub.docker.com/r/tarampampam/error-pages/
|
|
[link_nginx]:http://nginx.org/
|
|
[link_traefik]:https://docs.traefik.io/
|
|
[link_swarm]:https://docs.docker.com/engine/swarm/
|