From 3e79bd9476c0ac69e47e02f6310f6b21aaa49188 Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Tue, 13 Oct 2020 15:50:30 +0200
Subject: [PATCH] Update naming scheme for multi audio sources. #43
---
configuration/sample-development.engine.ini | 2 +-
configuration/sample-docker.engine.ini | 2 +-
configuration/sample-production.engine.ini | 2 +-
docs/installation-development.md | 4 ++--
docs/installation-production.md | 4 ++--
docs/setup-audio-store.md | 16 ++++++++--------
modules/plugins/monitor.py | 2 +-
7 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/configuration/sample-development.engine.ini b/configuration/sample-development.engine.ini
index eceff4e8..e70d1f5d 100644
--- a/configuration/sample-development.engine.ini
+++ b/configuration/sample-development.engine.ini
@@ -140,7 +140,7 @@ daemonuser="engineuser"
socketdir="/home/username/code/aura/engine/modules/liquidsoap"
[audiosources]
-audiofolder="var/audio/source"
+audio_source_folder="var/audio/source"
audio_source_extension=".flac"
[fallback]
diff --git a/configuration/sample-docker.engine.ini b/configuration/sample-docker.engine.ini
index 3e937187..9d60291e 100644
--- a/configuration/sample-docker.engine.ini
+++ b/configuration/sample-docker.engine.ini
@@ -138,7 +138,7 @@ daemonuser="engineuser"
socketdir="/srv/modules/liquidsoap"
[audiosources]
-audiofolder="var/audio/source"
+audio_source_folder="var/audio/source"
audio_source_extension=".flac"
[fallback]
diff --git a/configuration/sample-production.engine.ini b/configuration/sample-production.engine.ini
index b13a2c92..21639b06 100644
--- a/configuration/sample-production.engine.ini
+++ b/configuration/sample-production.engine.ini
@@ -138,7 +138,7 @@ daemonuser="engineuser"
socketdir="/opt/aura/engine/modules/liquidsoap"
[audiosources]
-audiofolder="var/audio/source"
+audio_source_folder="var/audio/source"
audio_source_extension=".flac"
[fallback]
diff --git a/docs/installation-development.md b/docs/installation-development.md
index aa38215e..2f866efb 100644
--- a/docs/installation-development.md
+++ b/docs/installation-development.md
@@ -162,8 +162,8 @@ Finally Engine needs to be able to access the audio folder, where all the tracks
are stored via *Tank*:
```ini
-[audiofolder]
-audiofolder="/var/audio"
+[audiosource]
+audio_source_folder="/var/audio"
```
If the audio device desired for playback is set as `default`, the Engine now should be ready to play
diff --git a/docs/installation-production.md b/docs/installation-production.md
index 2c4c3ee9..71a002d5 100644
--- a/docs/installation-production.md
+++ b/docs/installation-production.md
@@ -201,8 +201,8 @@ Finally Engine needs to be able to access the audio folder, where all the tracks
are stored via *Tank*:
```ini
-[audiofolder]
-audiofolder="/var/audio"
+[audiosource]
+audio_source_folder="/var/audio/source"
```
There is some document on how to [Setup the Audio Store](docs/setup-audio-store.md).
diff --git a/docs/setup-audio-store.md b/docs/setup-audio-store.md
index dffbceac..a86d4d0b 100644
--- a/docs/setup-audio-store.md
+++ b/docs/setup-audio-store.md
@@ -3,7 +3,7 @@
The *Audio Store* is a folder which is utilized by AURA Tank and Engine to exchange audio files.
-Assuming AURA Engine and Tank are hosted on different machines, the `audiofolder` must by shared
+Assuming AURA Engine and Tank are hosted on different machines, the `audio_source_folder` must by shared
using some network share.
In case you are hosting Engine and Tank on the same machine (e.g. in development), you can skip
@@ -21,13 +21,13 @@ this documentation. Just think about pointing them to the same directory.
<!-- /TOC -->
-By default Engine expects audio files shared by Tank in `/var/audio`.
+By default Engine expects audio files shared by Tank in `/var/audio/source`.
This can be configurated in `engine.ini`:
```ini
-[audiofolder]
-audiofolder="/var/audio"
+[audiosource]
+audio_source_folder="/var/audio/source"
```
Now, this folder must be somehow writable by Tank.
@@ -70,21 +70,21 @@ this documentation.
SSHFS allows you to access the filesystem on a remote computer via SSH. Interaction with files and folders behaves similar to any local data.
-This example is setting up the `audiofolder` on the Engine instance.
+This example is setting up the `audio_source_folder` on the Engine instance.
### Configuring Engine
-First, you'll need to create an user which enables Tank to access the `audiofolder` on Engine:
+First, you'll need to create an user which enables Tank to access the `audio_source_folder` on Engine:
```shell
adduser tankuser
-chown tankuser:engineuser /var/audio
+chown tankuser:engineuser /var/audio/source
```
Ensure that `engineuser` has no permissions to write the directory:
```shell
-chmod u=+rwx,go=+rx-w /var/audio
+chmod u=+rwx,go=+rx-w /var/audio/source
```
### Configuring Tank
diff --git a/modules/plugins/monitor.py b/modules/plugins/monitor.py
index 4fd631dd..080a7338 100644
--- a/modules/plugins/monitor.py
+++ b/modules/plugins/monitor.py
@@ -248,7 +248,7 @@ class AuraMonitor:
self.soundsystem.disable_transaction(self.soundsystem.client)
self.status["redis"]["active"] = self.validate_redis_connection()
- self.status["audio_store"] = self.validate_directory(self.config.get("audiofolder"))
+ self.status["audio_source"] = self.validate_directory(self.config.get("audio_source_folder"))
# After first update start the Heartbeat Monitor
if not self.heartbeat_running:
--
GitLab