diff --git a/README.md b/README.md index 6728a42d9c41b1cfb9e2e87d5249c79c33c6b25b..43a714bc7726c88715e4ff610f84c3a55aae2311 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,14 @@ It is tested and coded on Debian Stretch and Ubuntu 18.0 with Python 3.6+. git clone https://gitlab.servus.at/autoradio/engine ``` -**Install System Packages:** +**Install System Libraries:** + +Aura Engine requires at least Node 13 and Python 3.7. ```bash sudo apt install \ git \ + nodejs\ python3.7 python3.7-pip python3.7-dev \ redis-server \ libsndfile1 ffmpeg \ @@ -73,10 +76,10 @@ sudo apt install \ liquidsoap-plugin-all ``` -**Install Python Packages:** +**Install Engine Packages:** ```bash -./install.sh +sudo ./install.sh ``` **Setup Database:** @@ -107,21 +110,33 @@ Read more about detailed settings in the [Configuration Guide](docs/configuratio ## Start the Engine -To start the AuRa Engine execute: + +**Development:** While developing there is a simple convencience script `run.sh` +to get you started. Call the engine's components in following order: + +```shell + ./run.sh # Starts the engine-core component + ./run.sh lqs # Starts the engine-liquidsoap component + ./run.sh api # Starts the engine-api component +``` + +**Production:** In production the process is slightly different to ensure the +engine's components are always running i.e. restart themselves after some system +restart or crash. Therefore they are executed using a system service: ```bash - systemctl start aura-lqs systemctl start aura-engine + systemctl start aura-lqs + systemctl start aura-api ``` and on system boot run following: ```bash - systemctl enable aura-lqs systemctl enable aura-engine + systemctl enable aura-lqs ``` -The first service starts the LiquidSoap Engine, while the latter boots the actual AuRa Engine. ## Logging