@@ -10,16 +8,16 @@ the requirements of community radio stations.
<!-- TOC -->
1.[Aura Engine](#aura-engine)
1.[Functionality](#functionality)
1.[Scheduler](#scheduler)
1.[Versatile playlists](#versatile-playlists)
2.[Default playlists](#default-playlists)
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.[Functionality](#functionality)
1.[Scheduler](#scheduler)
1.[Versatile playlists](#versatile-playlists)
2.[Default playlists](#default-playlists)
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)
<!-- /TOC -->
...
...
@@ -30,11 +28,11 @@ In conjunction with other AURA components Engine provides several features:
-**Scheduler** to automatically broadcast your radio programme (see [AURA Dashboard](https://gitlab.servus.at/aura/dashboard) for a user interface to do scheduling)
-**Analog input and outputs** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
-**Streaming to an [Icecast](https://icecast.org/) Server including [Icy Metadata](https://cast.readme.io/docs/icy)** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
-**Autonomous playout** by caching the schedule information pulled from [Steering](https://gitlab.servus.at/aura/steering) in a local database. This allows Engine be keep running, independently from any network or service outages. This enables the application of (*High Availability* infrastructure scenarios)[https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/installation-guide.md#high-availability].
-**Autonomous playout** by caching the schedule information pulled from [Steering](https://gitlab.servus.at/aura/steering) in a local database. This allows Engine be keep running, independently from any network or service outages. This enables the application of (_High Availability_ infrastructure scenarios)[https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/installation-guide.md#high-availability].
-**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 after v1.1 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
...
...
@@ -60,13 +58,13 @@ The switching between types of audio source is handled automatically, with confi
While a timeslot can have a specific playlist assigned, it is also possible to define default playlists
for schedules and shows:
-**Default Schedule Playlist**: This playlist is defined on the level of some recurrence rules (*Schedule*).
In case the timeslot doesn't have any specific playlist assigned, this playlist is broadcasted.
-**Default Schedule Playlist**: This playlist is defined on the level of some recurrence rules (_Schedule_).
In case the timeslot doesn't have any specific playlist assigned, this playlist is broadcasted.
-**Default Show Playlist**: This playlist can be assigned to some show. If neither the specific timeslot
playlist nor the default schedule playlist is specified the *default show playlist* is broadcasted.
playlist nor the default schedule playlist is specified the _default show playlist_ is broadcasted.
If none of these playlists have been specified the *Auto DJ* feature of [Engine Core](https://gitlab.servus.at/aura/engine-core) takes over (optional).
If none of these playlists have been specified the _Auto DJ_ feature of [Engine Core](https://gitlab.servus.at/aura/engine-core) takes over (optional).
### Heartbeat Monitoring
...
...
@@ -98,7 +96,7 @@ You'll need update a few settings:
- 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).
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:
...
...
@@ -120,14 +118,12 @@ If no build is available it pulls the latest image from [Docker Hub](https://hub
-[Developer Guide](docs/developer-guide.md)
-[Setting up the Audio Store [meta]](https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/setup-audio-store.md)
Automated Radio (AURA) is a open source software suite for community radio stations. Learn more about AURA in the [Meta repository](https://gitlab.servus.at/aura/meta).
