Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaumebriday/traefik-custom-error-pages
Bunch of custom error pages for Traefik 2.x built with Jekyll
https://github.com/guillaumebriday/traefik-custom-error-pages
custom-error-pages netlify traefik
Last synced: 2 days ago
JSON representation
Bunch of custom error pages for Traefik 2.x built with Jekyll
- Host: GitHub
- URL: https://github.com/guillaumebriday/traefik-custom-error-pages
- Owner: guillaumebriday
- License: mit
- Created: 2018-11-21T10:00:49.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T15:57:01.000Z (over 1 year ago)
- Last Synced: 2024-10-23T11:47:14.509Z (11 days ago)
- Topics: custom-error-pages, netlify, traefik
- Language: CSS
- Homepage:
- Size: 42 KB
- Stars: 78
- Watchers: 6
- Forks: 30
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.paypal.me/guillaumebriday)
[](https://hub.docker.com/r/guillaumebriday/traefik-custom-error-pages/)
[](https://hub.docker.com/r/guillaumebriday/traefik-custom-error-pages/)
[](https://app.netlify.com/sites/traefik-custom-error-pages/deploys)
# ⚠️ DEPRECATION WARNING ⚠️
I'm not using this image anymore. I switched from Traefik to [Caddy](https://caddyserver.com) because Traefik is far too complicated for **my** needs. This image works as it. If you want new features, feel free to fork the project. An alternative project for the traefik error pages is [tarampampam/error-pages](https://github.com/tarampampam/error-pages). It also supports the theme used in this project.
# Custom error pages for Traefik
A bunch of custom error pages for Traefik built with [Jekyll](https://jekyllrb.com/).
## Development
Install dependencies
```bash
$ bundle install
```
If you want to build the project on your host:
```bash
$ jekyll build
```
If you want to preview the pages before building the Docker image :
```bash
$ jekyll serve
```
Open [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
## How to use with Traefik and Docker in Production
Run the container with labels, **change with your needs**:
```yml
# docker-compose.yml
errorpage:
image: guillaumebriday/traefik-custom-error-pages
restart: unless-stopped
networks:
- web
labels:
- traefik.enable: "true"
- traefik.docker.network: "web"
- traefik.http.routers.errorpage.entrypoints: "websecure"
- traefik.http.routers.errorpage.rule: "HostRegexp(`{host:.+}`)"
- traefik.http.services.globalerrorpage.loadbalancer.server.port: "80"
```
## Build the image
This is a [multi-stage build](https://docs.docker.com/develop/develop-images/multistage-build/), to build the final image:
```bash
$ docker build -f .cloud/docker/Dockerfile -t traefik-custom-error-pages .
```
## How it works?
As you can see in the Dockerfile, I use [Nginx](https://www.nginx.com/) as Web server to serve static files. To generate this pages, I use [Jekyll](https://jekyllrb.com/) in the first step of the build.
You will find in this article [https://www.techjunktrunk.com/docker/2017/11/03/traefik-default-server-catch-all](https://www.techjunktrunk.com/docker/2017/11/03/traefik-default-server-catch-all/) why I set up `rule` this way.
It's very useful because this container will respond to all requests only if there is no container with a real rule.
## Credits
I used the [Laravel](https://laravel.com/) default HTTP error pages.
## Contributing
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
## License
This project is released under the [MIT](http://opensource.org/licenses/MIT) license.