From bbada7b2a7ca1326a06ce4411f67961508d2d8fc Mon Sep 17 00:00:00 2001 From: David Trattnig <david.trattnig@o94.at> Date: Thu, 29 Jul 2021 15:36:59 +0200 Subject: [PATCH] Added install infos. --- docs/bare-metal-installation.md | 15 ++------------- docs/developer-guide.md | 4 +++- 2 files changed, 5 insertions(+), 14 deletions(-) diff --git a/docs/bare-metal-installation.md b/docs/bare-metal-installation.md index 3745216a..d8bf1f8b 100644 --- a/docs/bare-metal-installation.md +++ b/docs/bare-metal-installation.md @@ -75,7 +75,7 @@ cp config/sample.production.engine.ini config/engine.ini ### Setting up the database -The primary database supported by AURA is PostgreSQL. +Engine requires a PorstgreSQL database to cache any programme info locally: ```bash # Additional Python packages for PostgreSQL @@ -84,18 +84,7 @@ pip3 install -r contrib/postgresql-requirements.txt sudo -u postgres psql -f contrib/postgresql-create-database.sql ``` -Alternatively you can also use MariaDB: - -> Warning: Due to an [issue with Mysql/MariaDB](https://gitlab.servus.at/aura/engine/-/issues/75) we recommend using PostgreSQL only. - -```bash -# Additional Python packages for MariaDB -pip3 install -r contrib/mariadb-requirements.txt -# Create database and user (change password in script) -sudo mysql -u root -p < contrib/mariadb-database.sql -``` - -You might want to change the password for the database user created by the relevant script. +> Important: You might want to change the password for the database user created by the relevant script. ## Configuration diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 8eb88c7c..5916d9ec 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -57,7 +57,9 @@ Ensure you have following other projects up and running: - engine-api - engine-clock (optional) -Create an virtual environment allowing you to ensure having the proper Python version and dependencies: +The following steps espect you having done the bases configuration and set up a database as outlined in the [Native Installation](https://gitlab.servus.at/aura/engine/-/blob/master/docs/bare-metal-installation.md) document. + +If you don't have already, you'll need to create an virtual environment: ```shell ~/code/aura/engine$ virtualenv -p python3.8 python -- GitLab