From 5c9e3d8729c5253a8964c75f84c78e868f241ad6 Mon Sep 17 00:00:00 2001
From: Dominik George <dominik.george@teckids.org>
Date: Sun, 7 Mar 2021 17:09:58 +0100
Subject: [PATCH] Update development docs to use runuwsgi
---
docs/dev/01_setup.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/dev/01_setup.rst b/docs/dev/01_setup.rst
index d61c21e9a..31c72ee6c 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/
--
GitLab