exampleconfig.rst

Example configuration files

Examples of various configuration possibilities to help you get started. The source scripts are available too.

Projects configuration

This file includes the configration of which hooks are available.

../../example_config/examples.yaml

systemd unit file for webhaak webservice

../../example_config/systemd/webhaak.service

This uses a Gunicorn configuration file:

../../example_config/gunicorn_webhaak_conf.py

Supervisord for RQ worker

../../example_config/supervisord/webhaak_rq_worker.conf

nginx vhost

nxing configuration to serve the web application with; the application itself runs under systemd for example

../../example_config/nginx/hook.example.com.conf

Environment file

The various environment variables have to be put in the supervisord config and systemd unit file like described above; they can also be put in a .env file.

../../example_config/example.env

Helper scripts

Updating a webapp project (like a FastAPI one):

../../example_config/update_webapp.sh

Updating a Flask project:

../../example_config/update_flask.sh

Updating a Python virtualenv (also used by the Flask update script):

../../example_config/update_virtualenv.sh

Running flake8 linter and isort checker over a directory with Python files:

../../example_config/flake8diff.sh

Apache

Not officially supported anymore since the rewrite with FastAPI.

uWSGI

Not officially supported anymore since the rewrite with FastAPI.