Example configuration files
===========================

Examples of various configuration possibilities to help you get started. The `source scripts are available too <https://codeberg.org/diginaut/webhaak/src/branch/master/example_config>`_.


Projects configuration
----------------------

This file includes the configration of which hooks are available.

.. literalinclude:: ../../example_config/examples.yaml
   :language: yaml
   :linenos:


systemd unit file for webhaak webservice
----------------------------------------

.. literalinclude:: ../../example_config/systemd/webhaak.service
   :language: ini
   :linenos:

This uses a Gunicorn configuration file:

.. literalinclude:: ../../example_config/gunicorn_webhaak_conf.py
   :language: ini
   :linenos:


Supervisord for RQ worker
-------------------------

.. literalinclude:: ../../example_config/supervisord/webhaak_rq_worker.conf
   :language: ini
   :linenos:


nginx vhost
-----------

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

.. literalinclude:: ../../example_config/nginx/hook.example.com.conf
   :language: ini
   :linenos:


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.

.. literalinclude:: ../../example_config/example.env
   :language: ini
   :linenos:


Helper scripts
--------------

Updating a webapp project (like a FastAPI one):

.. literalinclude:: ../../example_config/update_webapp.sh
   :language: bash
   :linenos:

Updating a Flask project:

.. literalinclude:: ../../example_config/update_flask.sh
   :language: bash
   :linenos:

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

.. literalinclude:: ../../example_config/update_virtualenv.sh
   :language: bash
   :linenos:


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

.. literalinclude:: ../../example_config/flake8diff.sh
   :language: bash
   :linenos:


Apache
------

Not officially supported anymore since the rewrite with FastAPI.


uWSGI
-----

Not officially supported anymore since the rewrite with FastAPI.