@@ -32,19 +32,17 @@ This project is part of [Aura Radio Software Suite](https://gitlab.servus.at/aur
## Prerequisites
To [install the AURA Suite](https://gitlab.servus.at/aura/meta) we recommend using [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
> IMPORTANT: For live audio input inside Docker there are currently buffer and latency issues. After the [move the Liquidsoap 2.0](https://gitlab.servus.at/aura/engine-core/-/issues/4) it should be somewhat better. Also looking for tips on how to solve these issues. Therefore we right now recommend to do a bare-metal installation for *Engine Core*. If you don't require analog audio input you can safely use Docker. All other AURA components can be deployed using Docker though.
To install the AURA Suite for testing or production we recommend using the [Docker Compose](https://docs.aura.radio/en/latest/administration/install-docker-compose.html) installation instead. The following steps are aiming for developers.
You'll need to have following installed before proceeding:
-[Liquidsoap 1.4.4](https://www.liquidsoap.info/doc-1.4.4/install.html) installed using [OPAM (OCaml Package Manager)](https://opam.ocaml.org/) and these additional dependencies:
-[Liquidsoap 2.0.x](https://www.liquidsoap.info/) installed using [OPAM (OCaml Package Manager)](https://opam.ocaml.org/) and these additional dependencies:
Download a zipped version from the [*Engine Core* repository](https://gitlab.servus.at/aura/engine-core) page or clone some specific branch or tag using `git` to a local `aura/engine-core` directory. In order to allow easy updating we recommend the git approach.
Now clone this repository to your target instance.
## Quickstart
...
...
@@ -67,7 +65,7 @@ The aformentioned `audio` folder is the base for retrieving audio files. Engine
-**`audio/fallback/`**: A local folder for any emergency playback, also called *Station Fallback*. All audio files inside are played in a randomized order, if no actually scheduled music is played by the engine. The folder is being watched for changes. So you can add/remove audio on the fly. This fallback feature is enabled by default.
-**`audio/playlist/`**: Put a file `station-fallback-playlist.m3u` in here and it has the same effect as the fallback folder.
he playlist is being watched for changes. Set `fallback_type="playlist"` to enable this instead of the fallback folder.
-**`audio/source/`**: This is the location for audio files provided by [Tank](https://gitlab.servus.at/aura/tank). Usually any audio files which are part of the scheduled programme are read for their broadcast from here. If you are running all AURA components on a single machine you should be fine with just creating a symbolic link to the relevant Tank folder (`ln -s ../engine/audio ./audio`). But in some [distributed and redundant production scenario](https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/installation-guide.md) you might think about more advanced options on how to sync your audio files between machines. You can find some ideas in the doc " [Setting up the Audio Store](https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/setup-audio-store.md)".
-**`audio/source/`**: This is the location for audio files provided by [Tank](https://gitlab.servus.at/aura/tank). Usually any audio files which are part of the scheduled programme are read from here to perform broadcasts. If you are running all AURA components on a single machine you should be fine with just creating a symbolic link to the relevant Tank folder (`ln -s ../engine/audio ./audio`). But in some [distributed and redundant production scenario](https://docs.aura.radio/en/latest/administration/deployment-scenarios.html) you might think about more advanced options on how to sync your audio files between machines. You can find some ideas in the doc " [Setting up the Audio Store](https://docs.aura.radio/en/latest/administration/setup-audio-store.html)".
## Advanced Configuration
...
...
@@ -81,7 +79,7 @@ The Engine Core logs can be found under `./logs`.
## Other AURA Components
After successfully running Engine Core you might look into getting started with [the other Engine Components](https://gitlab.servus.at/aura/engine) and [AURA Web](https://gitlab.servus.at/aura/meta).
After successfully running Engine Core you might look into getting started with [the other Engine Components](https://gitlab.servus.at/aura/engine) and [AURA Web](https://docs.aura.radio/en/latest/administration/overview.html).
## Read more
...
...
@@ -90,10 +88,4 @@ After successfully running Engine Core you might look into getting started with
AURA stands for Automated Radio and is a swiss army knife for community radio stations. Beside the Engine it provides Steering (Admin Interface for the radio station), Dashboard (Collaborative scheduling and programme coordination), Tank (Audio uploading, pre-processing and delivery). Read more in the [Aura Meta](https://gitlab.servus.at/aura/meta) repository or on the specific project pages.
