diff --git a/docs/dev/01_setup.rst b/docs/dev/01_setup.rst index d61c21e9a074310ec599f8bcffb6824dabe64bac..31c72ee6c8bcaea746291ab038318fa614f0103d 100644 --- a/docs/dev/01_setup.rst +++ b/docs/dev/01_setup.rst @@ -78,12 +78,14 @@ Running the development server ------------------------------ The development server can be started using Django's ``runserver`` command. +If you want to automatically start other necessary tools in development, +like the `Celery` worker and scheduler, use ``runuwsgi`` instead. You can either configure AlekSIS like in a production environment, or pass basic settings in as environment variable. Here is an example that runs the development server against a local PostgreSQL database with password `aleksis` (all else remains default) and with the `debug` setting enabled:: - ALEKSIS_debug=true ALEKSIS_database__password=aleksis poetry run ./manage.py runserver + ALEKSIS_debug=true ALEKSIS_database__password=aleksis poetry run ./manage.py runuwsgi .. figure:: /screenshots/index.png :scale: 50% @@ -95,3 +97,4 @@ development server against a local PostgreSQL database with password .. _Poetry: https://poetry.eustace.io/ .. _Poetry installation methods: https://poetry.eustace.io/docs/#installation .. _Yarn: https://yarnpkg.com +.. _Celery: https://celeryproject.org/