diff --git a/docs/dev/01_setup.rst b/docs/dev/01_setup.rst index dd3121a822e53c603b21511b790f5ef6950f295a..24a64dbf7b7536193f7691538b2846409782519d 100644 --- a/docs/dev/01_setup.rst +++ b/docs/dev/01_setup.rst @@ -20,7 +20,7 @@ AlekSIS requires `PostgreSQL`_ (version 13 or newer) as database backend. To provide a database names `aleksis` with a user named `aleksis` on Debian:: - sudo apt install postgresql-13 + sudo apt install postgresql sudo -u postgres createuser -P aleksis sudo -u postgres createdb -O aleksis aleksis @@ -86,16 +86,15 @@ some maintenance tasks need to be done: 2. Collect static files 3. Run database migrations -All three steps can be done with the ``poetry run`` command and +All three steps can be done with the ``poetry shell`` command and ``aleksis-admin``:: - poetry run aleksis-admin yarn install - poetry run aleksis-admin collectstatic - poetry run aleksis-admin compilemessages - poetry run aleksis-admin migrate - poetry run aleksis-admin createinitialrevisions - -(You might need database settings for the `migrate` command; see below.) + ALEKSIS_maintenance__debug=true ALEKSIS_database__password=aleksis poetry shell + poetry run aleksis-admin yarn install + poetry run aleksis-admin collectstatic + poetry run aleksis-admin compilemessages + poetry run aleksis-admin migrate + poetry run aleksis-admin createinitialrevisions Running the development server ------------------------------ @@ -108,7 +107,7 @@ 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 aleksis-admin runuwsgi + ALEKSIS_maintenance__debug=true ALEKSIS_database__password=aleksis poetry run aleksis-admin runuwsgi .. figure:: /screenshots/index.png :scale: 50%