https://github.com/byceps/byceps
Tip revision: 2f307b8cbe1b3b51b8d28fe40a3aafd8e178b0af authored by Jochen Kupperschmidt on 16 February 2026, 03:05:23 UTC
Adjust test to new `hidden` argument to `page_service.update_page`
Adjust test to new `hidden` argument to `page_service.update_page`
Tip revision: 2f307b8
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.
