@@ -26,7 +26,6 @@ Aura Engine runs on any modern Debian-based OS. It requires at least
...
@@ -26,7 +26,6 @@ Aura Engine runs on any modern Debian-based OS. It requires at least
-[`git`](https://git-scm.com/)
-[`git`](https://git-scm.com/)
-[PostgreSQL 13+](https://www.postgresql.org/)
-[PostgreSQL 13+](https://www.postgresql.org/)
**Setting up the project structure**
**Setting up the project structure**
Then clone all `engine` related projects to some development folder. In production we recommend `/opt/aura/` as the system base.
Then clone all `engine` related projects to some development folder. In production we recommend `/opt/aura/` as the system base.
...
@@ -45,6 +44,7 @@ If you are developing engine you also might want the projects `steering`, `dashb
...
@@ -45,6 +44,7 @@ If you are developing engine you also might want the projects `steering`, `dashb
## Preparation
## Preparation
Install dependencies:
Install dependencies:
```shell
```shell
apt install\
apt install\
python3-wheel \
python3-wheel \
...
@@ -89,9 +89,7 @@ In your development environment edit following file to configure the engine:
...
@@ -89,9 +89,7 @@ In your development environment edit following file to configure the engine:
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.
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:
Required modifications are: - The password `db_pass` for the local database holding scheduling information - The app secret `api_tank_secret` for connecting to [AURA Tank](https://gitlab.servus.at/aura/tank)
- The password `db_pass` for the local database holding scheduling information
- The app secret `api_tank_secret` for connecting to [AURA Tank](https://gitlab.servus.at/aura/tank)
## Running Engine
## Running Engine
...
@@ -101,7 +99,7 @@ There's a convencience script `run.sh` to get engine started
...
@@ -101,7 +99,7 @@ There's a convencience script `run.sh` to get engine started
engine$ ./run.sh
engine$ ./run.sh
```
```
The script executes the *default target*, which is usually `dev` for development environments.
The script executes the _default target_, which is usually `dev` for development environments.
You can call this target explicitly too:
You can call this target explicitly too:
...
@@ -143,7 +141,7 @@ The daemon configs are expecting you run engine under the user `engineuser` and
...
@@ -143,7 +141,7 @@ The daemon configs are expecting you run engine under the user `engineuser` and
### Running with Systemd
### Running with Systemd
Copy the unit files in `/opt/aura/engine/config/systemd/aura-engine.service` to your systemd unit directory, and reload the systemd daemon:
Copy the unit files in `/opt/aura/engine/config/systemd/aura-engine.service` to your systemd unit directory, and reload the systemd daemon:
