@@ -15,9 +15,10 @@ the requirements of community radio stations.
2.[Heartbeat Monitoring](#heartbeat-monitoring)
3.[Logging](#logging)
2.[Getting started](#getting-started)
3.[Using Docker](#using-docker)
4.[Read more](#read-more)
5.[About](#about)
1.[Run natively](#run-natively)
2.[Run with Docker](#run-with-docker)
3.[Read more](#read-more)
4.[About](#about)
<!-- /TOC -->
...
...
@@ -32,7 +33,7 @@ In conjunction with other AURA components Engine provides several features:
-**Auto DJ with Silcence Detector** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
-**Web Application for a Track Service** (see [AURA Player](https://gitlab.servus.at/aura/player))
-**Web Application providing a Studio Clock** (see [Dashboard Clock](https://gitlab.servus.at/aura/dashboard-clock))
-**Bulk and Timeslot Recorder** (_Not yet available_, this will be provided after v1.1 by a planned `engine-recorder` component)
-**Bulk and Timeslot Recorder** (_Not yet available_, this will be provided by a planned `engine-recorder` component)
-**API** to query Track-Service, monthly reports and information for displaying the Studio Clock (see [Engine API](https://gitlab.servus.at/aura/engine-api))
### Scheduler
...
...
@@ -76,41 +77,15 @@ All Engine logs can be found in the local `./logs` directory. Adapt the log-leve
## Getting started
Ensure that you have also dependencies such as `steering`, `tank`, `dashboard`, `engine-core`, and `engine-api` up and running. There's a how-to in the [Meta](https://gitlab.servus.at/aura/meta) repository to get quickly started using [Docker Compose](https://docs.docker.com/compose/).
Ensure that you have also dependencies such as `steering`, `tank`, `dashboard`, `engine-core`, and `engine-api` up and running.
For production we recommend running Engine using Docker Compose. If you want to install for AURA development or simply prefer to run natively, check out the [Bare Metal Installation](docs/bare-metal-installation.md).
### Run natively
## Using Docker
If you want to install for AURA development or simply prefer to run natively, check out the [Bare Metal Installation](docs/bare-metal-installation.md).
If you only want to run a single Engine Docker container, you can do this in a few, simple steps.
### Run with Docker
Before getting started copy the default configuration file to `config/engine.docker.ini`:
- 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)
- Also check the `ENV` variables defined in the `run.sh` script.
At the moment production deployment using Docker and Docker Compose is [_work in progress_](https://gitlab.servus.at/aura/meta/-/issues/56).
If you would like to run the local codebase, starting Engine in Docker requires you to do a build first:
```shell
./run.sh docker:build
```
After your build has finished start the Engine with following command.
If no build is available it pulls the latest image from [Docker Hub](https://hub.docker.com/r/autoradio/engine).
```shell
./run.sh docker:dev
```
For production deployments follow the [Docker](https://docs.aura.radio/en/latest/administration/install-docker.html) and [Docker Compose](https://docs.aura.radio/en/latest/administration/install-docker-compose.html) Installation Documentation at [docs.aura.radio](https://docs.aura.radio/).
