From 1796e9a5eae50a33c6fc6b20e67a846ca858b4a6 Mon Sep 17 00:00:00 2001 From: David Trattnig <david.trattnig@o94.at> Date: Thu, 29 Oct 2020 13:51:04 +0100 Subject: [PATCH] Moved "configuration" to "config". #50 --- .gitignore | 6 +++--- .gitlab-ci.yml | 2 +- {configuration => config}/blank.flac | Bin {configuration => config}/playlists/.gitignore | 0 .../sample-development.engine.ini | 2 +- {configuration => config}/sample-docker.engine.ini | 2 +- .../sample-production.engine.ini | 2 +- .../supervisor/aura-engine.conf | 0 .../systemd/aura-engine-core.service | 0 .../systemd/aura-engine-lqs.service | 0 .../systemd/aura-engine-lqs.socket | 0 .../systemd/aura-engine.service | 0 docs/installation-development.md | 4 ++-- docs/installation-production.md | 4 ++-- docs/running-docker.md | 2 +- install.sh | 6 +++--- modules/base/config.py | 4 ++-- modules/liquidsoap/settings.liq | 4 ++-- run.sh | 2 +- script/initialize.sh | 2 +- supervisord.conf | 2 +- 21 files changed, 22 insertions(+), 22 deletions(-) rename {configuration => config}/blank.flac (100%) rename {configuration => config}/playlists/.gitignore (100%) rename {configuration => config}/sample-development.engine.ini (99%) rename {configuration => config}/sample-docker.engine.ini (99%) rename {configuration => config}/sample-production.engine.ini (99%) rename {configuration => config}/supervisor/aura-engine.conf (100%) rename {configuration => config}/systemd/aura-engine-core.service (100%) rename {configuration => config}/systemd/aura-engine-lqs.service (100%) rename {configuration => config}/systemd/aura-engine-lqs.socket (100%) rename {configuration => config}/systemd/aura-engine.service (100%) diff --git a/.gitignore b/.gitignore index a6d94d5c..f4e66876 100644 --- a/.gitignore +++ b/.gitignore @@ -4,11 +4,11 @@ logs tmp .vscode/tags -configuration/engine.ini +config/engine.ini script/.engine.install-db.lock .engine.install-db.lock -configuration/systemd/dev/ +config/systemd/dev/ env.list audio/source -configuration/docker/engine.ini +config/docker/engine.ini modules/liquidsoap/engine.sock \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 808af8a7..41aff226 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -21,7 +21,7 @@ before_script: - mkdir /etc/aura - mkdir /var/log/aura - pwd - - cp configuration/sample-production.engine.ini configuration/engine.ini + - cp config/sample-production.engine.ini config/engine.ini no_test_cases: stage: test diff --git a/configuration/blank.flac b/config/blank.flac similarity index 100% rename from configuration/blank.flac rename to config/blank.flac diff --git a/configuration/playlists/.gitignore b/config/playlists/.gitignore similarity index 100% rename from configuration/playlists/.gitignore rename to config/playlists/.gitignore diff --git a/configuration/sample-development.engine.ini b/config/sample-development.engine.ini similarity index 99% rename from configuration/sample-development.engine.ini rename to config/sample-development.engine.ini index b3de4e33..8c3d3a1e 100644 --- a/configuration/sample-development.engine.ini +++ b/config/sample-development.engine.ini @@ -144,7 +144,7 @@ fallback_max_blank="20." fallback_min_noise="0." fallback_threshold="-50." # A playlist holding music for Station Fallbacks (optonal) -fallback_music_playlist= "/home/username/code/aura/configuration/playlists/station-fallback-playlist.m3u" +fallback_music_playlist= "/home/username/code/aura/config/playlists/station-fallback-playlist.m3u" # A folder holding music for Station Fallbacks (optional) fallback_music_folder="/var/audio/station" # The time in seconds how often the folder should be re-scanned diff --git a/configuration/sample-docker.engine.ini b/config/sample-docker.engine.ini similarity index 99% rename from configuration/sample-docker.engine.ini rename to config/sample-docker.engine.ini index bdd0a188..25839a02 100644 --- a/configuration/sample-docker.engine.ini +++ b/config/sample-docker.engine.ini @@ -143,7 +143,7 @@ fallback_max_blank="20." fallback_min_noise="0." fallback_threshold="-50." # A playlist holding music for Station Fallbacks (optonal) -fallback_music_playlist= "/opt/aura/engine/configuration/playlists/station-fallback-playlist.m3u" +fallback_music_playlist= "/opt/aura/engine/config/playlists/station-fallback-playlist.m3u" # A folder holding music for Station Fallbacks (optional) fallback_music_folder="/var/audio/station" # The time in seconds how often the folder should be re-scanned diff --git a/configuration/sample-production.engine.ini b/config/sample-production.engine.ini similarity index 99% rename from configuration/sample-production.engine.ini rename to config/sample-production.engine.ini index bf58f432..e5c6908f 100644 --- a/configuration/sample-production.engine.ini +++ b/config/sample-production.engine.ini @@ -143,7 +143,7 @@ fallback_max_blank="20." fallback_min_noise="0." fallback_threshold="-50." # A playlist holding music for Station Fallbacks (optonal) -fallback_music_playlist= "/opt/aura/engine/configuration/playlists/station-fallback-playlist.m3u" +fallback_music_playlist= "/opt/aura/engine/config/playlists/station-fallback-playlist.m3u" # A folder holding music for Station Fallbacks (optional) fallback_music_folder="/var/audio/station" # The time in seconds how often the folder should be re-scanned diff --git a/configuration/supervisor/aura-engine.conf b/config/supervisor/aura-engine.conf similarity index 100% rename from configuration/supervisor/aura-engine.conf rename to config/supervisor/aura-engine.conf diff --git a/configuration/systemd/aura-engine-core.service b/config/systemd/aura-engine-core.service similarity index 100% rename from configuration/systemd/aura-engine-core.service rename to config/systemd/aura-engine-core.service diff --git a/configuration/systemd/aura-engine-lqs.service b/config/systemd/aura-engine-lqs.service similarity index 100% rename from configuration/systemd/aura-engine-lqs.service rename to config/systemd/aura-engine-lqs.service diff --git a/configuration/systemd/aura-engine-lqs.socket b/config/systemd/aura-engine-lqs.socket similarity index 100% rename from configuration/systemd/aura-engine-lqs.socket rename to config/systemd/aura-engine-lqs.socket diff --git a/configuration/systemd/aura-engine.service b/config/systemd/aura-engine.service similarity index 100% rename from configuration/systemd/aura-engine.service rename to config/systemd/aura-engine.service diff --git a/docs/installation-development.md b/docs/installation-development.md index 68ada7bc..663b281e 100644 --- a/docs/installation-development.md +++ b/docs/installation-development.md @@ -94,7 +94,7 @@ This script does the following: - Install Liquidsoap components using OPAM (`script/install-opam-packages`) - NodeJS Modules (`script/install-web.sh`) - Python Packages (`requirements.txt`) -- Creates a default configuration file in `configuration/engine.ini` +- Creates a default configuration file in `config/engine.ini` When this is completed, carefully check if any error occured. @@ -104,7 +104,7 @@ When this is completed, carefully check if any error occured. In your development environment edit following file to configure the engine: ```shell -./configuration/engine.ini +./config/engine.ini ``` Please note if some configuration exists under `/etc/aura/engine.ini` the configuration is diff --git a/docs/installation-production.md b/docs/installation-production.md index fa2b0f59..1137e389 100644 --- a/docs/installation-production.md +++ b/docs/installation-production.md @@ -223,7 +223,7 @@ For this you can utilize either [Systemd](https://systemd.io/) or [Supervisor](h ### Running with Systemd -Copy the unit file `/opt/aura/engine/configuration/systemd/aura-engine.service` to `/etc/systemd/system/`. +Copy the unit file `/opt/aura/engine/config/systemd/aura-engine.service` to `/etc/systemd/system/`. This unit file starts engine-core and engine-liquidsoap within one command. Here Liquidsoap is started as as subprocess. @@ -270,7 +270,7 @@ supervisord ``` This picks up the supervisor configuration provided in the local `supervisord.conf` and the service configurations -located in `configuration/supervisor/*.conf`. +located in `config/supervisor/*.conf`. Experience has shown it might be helpful to reload the supervisor configuration using `sudo`: diff --git a/docs/running-docker.md b/docs/running-docker.md index 1c8d1c69..56a432db 100644 --- a/docs/running-docker.md +++ b/docs/running-docker.md @@ -29,7 +29,7 @@ try the [Standard Installation](docs/installation-development). Create a default configuration and edit according to your settings ```shell -cp configuration/sample-docker.engine.ini configuration/docker/engine.ini +cp config/sample-docker.engine.ini config/docker/engine.ini ``` Create a symlink in `./audio` to point to the audio source of tank diff --git a/install.sh b/install.sh index d654327b..69de97a4 100755 --- a/install.sh +++ b/install.sh @@ -39,8 +39,8 @@ if [ $mode == "dev" ]; then echo "Create local 'logs' Folder ..." mkdir -p logs - echo "Copy configuration to './configuration/engine.ini'" - cp -n configuration/sample-development.engine.ini configuration/engine.ini + echo "Copy configuration to './config/engine.ini'" + cp -n config/sample-development.engine.ini config/engine.ini fi @@ -53,7 +53,7 @@ if [ $mode == "prod" ]; then mkdir -p tmp echo "Copy default Engine configuration to '/etc/aura/engine.ini'" - cp -n configuration/sample-production.engine.ini /etc/aura/engine.ini + cp -n config/sample-production.engine.ini /etc/aura/engine.ini fi diff --git a/modules/base/config.py b/modules/base/config.py index afba671c..17620194 100644 --- a/modules/base/config.py +++ b/modules/base/config.py @@ -40,7 +40,7 @@ class AuraConfig: def __init__(self, ini_path="/etc/aura/engine.ini"): """ Initializes the configuration, defaults to `/etc/aura/engine.ini`. - If this file doesn't exist it uses `./configuration/engine.ini` from + If this file doesn't exist it uses `./config/engine.ini` from the project directory. Args: @@ -49,7 +49,7 @@ class AuraConfig: self.logger = logging.getLogger("AuraEngine") config_file = Path(ini_path) if not config_file.is_file(): - ini_path = "%s/configuration/engine.ini" % Path(__file__).parent.parent.parent.absolute() + ini_path = "%s/config/engine.ini" % Path(__file__).parent.parent.parent.absolute() self.ini_path = ini_path self.load_config() diff --git a/modules/liquidsoap/settings.liq b/modules/liquidsoap/settings.liq index 57dbd3be..fa7f743e 100644 --- a/modules/liquidsoap/settings.liq +++ b/modules/liquidsoap/settings.liq @@ -19,12 +19,12 @@ # READ INI FILE %include "readini.liq" -default_config = "../../configuration/engine.ini" +default_config = "../../config/engine.ini" config = list.hd(default=default_config, get_process_lines("ls /etc/aura/engine.ini")) log("Config file used: #{config}") ini = read_ini(config) engine_config_folder = string.split(separator="/engine.ini", config) -engine_config_folder = list.nth(default="../../configuration/", engine_config_folder, 0) +engine_config_folder = list.nth(default="../../config/", engine_config_folder, 0) # ALLOW LIQUIDSOAP RUN AS ROOT lqs_allow_root = list.assoc(default="false", "liquidsoap_as_root", ini) diff --git a/run.sh b/run.sh index 09cbcad5..b5103763 100755 --- a/run.sh +++ b/run.sh @@ -98,7 +98,7 @@ if [[ $docker == "true" ]]; then -u $UID:$GID \ -v "$BASE_D":/srv \ -v "$BASE_D/audio/source":/var/audio/source:ro \ - -v "$BASE_D/configuration/docker":/etc/aura \ + -v "$BASE_D/config/docker":/etc/aura \ -v "/dev/snd":/dev/snd \ --privileged \ --tmpfs /var/log/aura/ \ diff --git a/script/initialize.sh b/script/initialize.sh index e2d1fe6d..922b3182 100755 --- a/script/initialize.sh +++ b/script/initialize.sh @@ -19,4 +19,4 @@ chown -R engineuser:engineuser /var/log/aura chown -R engineuser:engineuser /var/log/supervisor echo "Copy Systemd unit files to '/etc/systemd/system/'" -cp -n /opt/aura/engine/configuration/systemd/* /etc/systemd/system/ \ No newline at end of file +cp -n /opt/aura/engine/config/systemd/* /etc/systemd/system/ \ No newline at end of file diff --git a/supervisord.conf b/supervisord.conf index 16552263..1681ca91 100644 --- a/supervisord.conf +++ b/supervisord.conf @@ -27,4 +27,4 @@ serverurl=unix:///opt/aura/engine/tmp/supervisor.sock ; use a unix:// URL for a [include] ; files = /etc/supervisor/conf.d/*.conf -files = /opt/aura/engine/configuration/supervisor/*.conf +files = /opt/aura/engine/config/supervisor/*.conf -- GitLab