https://github.com/byceps/byceps
Tip revision: 6fa71d12859037ed455b86801f7bf67a663ab141 authored by Jochen Kupperschmidt on 07 December 2025, 22:01:17 UTC
Do not persist auth token in Git config in CI actions
Do not persist auth token in Git config in CI actions
Tip revision: 6fa71d1
run.rst
**********
Run BYCEPS
**********
Applications
============
To run the applications defined in the :ref:`application mapping
<Map Applications>` with Flask's (insecure!)
*development* server for development purposes:
.. code-block:: console
$ uv run flask --app=serve_apps --debug run
If the hostname mapping (or DNS setup) is also correct, the configured
BYCEPS applications should be accessible at their respective hostnames
on Flask's standard port (5000), for example:
- `<http://admin.byceps.example:5000/>`_
- `<http://api.byceps.example:5000/>`_
- `<http://cozylan.example:5000/>`_
Worker
======
The worker processes background jobs for the admin application and site
applications.
To start it:
.. code-block:: console
$ uv run byceps worker
It should start processing any jobs in the queue right away and will
then wait for new jobs to be enqueued.
While technically multiple workers could be employed, a single one is
usually sufficient.
