diff --git a/docs/dev/01_setup.rst b/docs/dev/01_setup.rst index c41dbcb4fc8274688d6fa2729dc2523013e93097..0a87516958bd8ebf6e0811e6273c50359fac659e 100644 --- a/docs/dev/01_setup.rst +++ b/docs/dev/01_setup.rst @@ -10,8 +10,25 @@ environment that contains AlekSIS and everything you need to run the framework and selected apps. Also, `Yarn`_ is needed to resolve JavaScript dependencies. + For repository management, `myrepos` is required. +Setup database and message broker +--------------------------------- + +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 -u postgres createuser -P aleksis + sudo -u postgres createdb -O aleksis aleksis + +Additionally, `Redis`_ is used as message broker and for caching. +The default configuration of the server in Debian is sufficient:: + + sudo apt install redis-server + Get the source tree -------------------