CTF Pilot's Error Fallback

Error fallback webserver

This repository contains a webserver, which is used as the fallback webserver for errors.
It allows for custom error pages to be shown when errors occur in the CTF Pilot ecosystem.

How to run

For Kubernetes environments, deploy the deployment file provided in k8s.
This can be done with kubectl:

kubectl apply -f k8s/k8s.yml

The service can also be run locally, using the provided Docker compose file:

docker compose up -d

A Docker image is automatically built and published to GitHub Container Registry for each release.
You can pull the latest image with:

docker pull ghcr.io/ctfpilot/error-fallback:latest

For the versions available, please see the releases page.

Development

In order to generate the pages, run the generator.py script in src:

python3 src/generator.py

This is done automatically in the Docker container build process.

To update the Kubernetes deployment file, update the deployment template in template/k8s.yml.
An updated k8s/k8s.yml will then be automatically generated on the next release.

Contributing

We welcome contributions of all kinds, from code and documentation to bug reports and feedback!

Please check the Contribution Guidelines (CONTRIBUTING.md) for detailed guidelines on how to contribute.

To maintain the ability to distribute contributions across all our licensing models, all code contributions require signing a Contributor License Agreement (CLA). You can review the CLA here. CLA signing happens automatically when you create your first pull request.
To administrate the CLA signing process, we are using CLA assistant lite.

A copy of the CLA document is also included in this repository as CLA.md.
Signatures are stored in the cla repository.

License

This schema and repository is licensed under the EUPL-1.2 License.
You can find the full license in the LICENSE file.

We encourage all modifications and contributions to be shared back with the community, for example through pull requests to this repository.
We also encourage all derivative works to be publicly available under the EUPL-1.2 License.
At all times must the license terms be followed.

For information regarding how to contribute, see the contributing section above.

CTF Pilot is owned and maintained by The0Mikkel.
Required Notice: Copyright Mikkel Albrechtsen (https://themikkel.dk)

Code of Conduct

We expect all contributors to adhere to our Code of Conduct to ensure a welcoming and inclusive environment for all.