diff --git a/docs/bare-metal-installation.md b/docs/bare-metal-installation.md index 297b74f7548aa095213b54d3285eb618399681f2..343458f9b084bf4ab3bd2773489a79a88121e3ec 100644 --- a/docs/bare-metal-installation.md +++ b/docs/bare-metal-installation.md @@ -2,17 +2,17 @@ <!-- TOC --> -- [Install for Development](#install-for-development) - - [Prerequisites](#prerequisites) - - [Preparation](#preparation) - - [Setting up the database](#setting-up-the-database) - - [Configuration](#configuration) - - [Running Engine](#running-engine) - - [Daemonized Engine](#daemonized-engine) - - [Running with Systemd](#running-with-systemd) - - [Running with Supervisor](#running-with-supervisor) - - [Logging](#logging) - - [Read more](#read-more) +1. [Install for Development](#install-for-development) + 1. [Prerequisites](#prerequisites) + 2. [Preparation](#preparation) + 1. [Setting up the database](#setting-up-the-database) + 3. [Configuration](#configuration) + 4. [Running Engine](#running-engine) + 5. [Daemonized Engine](#daemonized-engine) + 1. [Running with Systemd](#running-with-systemd) + 2. [Running with Supervisor](#running-with-supervisor) + 6. [Logging](#logging) + 7. [Read more](#read-more) <!-- /TOC --> @@ -23,8 +23,8 @@ Aura Engine runs on any modern Debian-based OS. It requires at least - [Python 3.8+](https://www.python.org/downloads/release/python-380/) - [`pip`](https://pip.pypa.io/en/stable/) - [`git`](https://git-scm.com/) -- [`virtualenv`](https://pypi.org/project/virtualenv/) -- [PostgreSQL 13+](https://www.postgresql.org/) +- 'python3.8-venv' or [`virtualenv`](https://pypi.org/project/virtualenv/) +- [PostgreSQL 12+](https://www.postgresql.org/) **Setting up the project structure** @@ -68,9 +68,9 @@ Create your base configuration from the sample configuration ```shell # Development -cp config/sample.development.engine.ini config/engine.ini +cp config/sample-development.engine.ini config/engine.ini # Production -cp config/sample.production.engine.ini config/engine.ini +cp config/sample-production.engine.ini config/engine.ini ``` ### Setting up the database @@ -94,9 +94,9 @@ In your development environment edit following file to configure the engine: ./config/engine.ini ``` -> Please note, if some configuration exists under `/etc/aura/engine.ini` the configuration by default is drawn from there. +> Please note, if some configuration exists under `/etc/aura/engine.ini` the configuration by default is drawn from there. This overrides any configuration located in `./engine/config`. -While the configuration has plenty of configuration options, you only need to set a few mandatory ones, given you are running the other components (such as 'engine-core', "engine-api" etc.) at the default settings too. +While the configuration file has plenty of options, you only need to set a few mandatory ones, given you are running the other components (such as 'engine-core', "engine-api" etc.) at their default settings too. Required modifications are: - The password `db_pass` for the local database holding scheduling information @@ -110,19 +110,27 @@ If you have defined a virtual env during the installation step you'll need to ac source python/bin/activate ``` -There's a convencience script `run.sh` to get engine started +There's a convencience script `run.sh` to get Engine components started: ```shell - engine$ ./run.sh +engine$ ./run.sh ``` -Keep in mind you'll also need to start Engine Core separately +Keep in mind you'll also need to start Engine Core separately. + +> Note it should not matter in which order you start Engine and Engine Core. ```shell - engine-core$ ./run.sh +engine-core$ ./run.sh ``` -In order to have a full engine experience also the other AURA Components are required to be running. For convencience in starting the full environment checkout how to run Aura Web using Docker Compose within the [Meta Repository](https://gitlab.servus.at/aura/tank) +Last but not least, Engine API is the target service to store playlogs, health information and details for the [Studio Clock](https://gitlab.servus.at/aura/dashboard-clock). + +```shell +engine-core$ ./run.sh +``` + +In order to have the complete Engine experience, other AURA Components are required to be running too. Checkout the [Meta Repository](https://gitlab.servus.at/aura/meta) on how to run for example AURA Web using Docker Compose. ## Daemonized Engine @@ -141,7 +149,7 @@ systemctl daemon-reload ### Running with Supervisor -Now, given you are in the engine's home directory `/opt/aura/engine/`, simply type following to start the services: +Now, given you are in the engine's home directory like `/opt/aura/engine/`, simply type following to start the services: ```shell supervisord @@ -155,8 +163,6 @@ Then you'll need to reload the supervisor configuration using `sudo`: sudo supervisorctl reload ``` - - ## Logging All Engine logs can be found under `./logs`.