Setting up the home and aura user¶
aura repository to the server(s) you want to deploy AURA Web or AURA Playout at.
We recommend using
/opt/aura as your home for the AURA installation.
sudo git clone https://gitlab.servus.at/aura/aura.git /opt/aura
Next, move to that directory and create the
aura user. This user is used for running all services.
The directory under
/opt/aura is now owned by
All resources will be owned by the user
aura, hence we recommend performing all subsequent commands
as this user or to add the current user to the
Selecting the release¶
First check for available releases.
$ git tag 1.0.0-alpha1 1.0.0-alpha2 1.0.0-alpha3
This command returns a list of all tags corresponding to the available releases. Alternatively you can take a look at releases.aura.radio.
To learn about changes between releases, consult the Release Notes.
Then switch to the release you’d like to use.
git checkout tags/<release-version>
<release_version> with one of the versions listed above, like
git checkout tags/1.0.0-alpha1
Latest, unreleased state on the main branch
In case you want deploy the current development state, just take the latest commit on the
branch. That’s the state which is checked out by default. While we try to keep the
as stable as possible, we cannot guarantee it being functional at all times. So please use it at
your own risk.
Setting up the Audio Store¶
The Audio Store is a folder which is utilized by Tank and Engine to exchange audio files.
Assuming both, Engine and Tank are hosted on different machines, audio folders must by shared using some network share.
In case you are hosting Engine and Tank on the same machine, you can skip this step. Just think about pointing the settings the relevant audio directories, or create a symlink to do so behind the curtains.
By default the audio store is located in
/opt/aura/audio. There are following subdirectories
source: Holding all audio files from the media asset repository. Written by Tank and read by Engine.
fallback: Populate this folder with audio files to be played randomly, in cases where nothing is scheduled.
playlist: Used for M3U audio playlists.
recordings: The recorder stores its recorded blocks here.
import: To import audio files into Tank via the filesystem, place them here.
In the following steps, you will be advised to copy the provided
sample.env file to
most common setup scenarios all configuration done in such
.env file is sufficient.
For some more advanced setups or debug purposes, there are also sample configuration files for each
/opt/aura/config/services/sample-config available. To overwrite any service
configuration, simply copy its configuration file to the parent
Only use these overrides if you are an advanced user, or are advised to do so.
AURA can be deployed using Docker and Docker Compose, allowing custom-tailored orchestration.
In general we recommend the Docker Compose variant.