From 55e5e73ae1a27c69d668f6268af2bba41aaf8b7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alban=20F=C3=A9ron?= Date: Sat, 18 Jan 2020 17:20:58 +0100 Subject: [PATCH] Small config doc/sample update Closes #177 Closes #178 --- config.sample | 9 ++++++--- docs/configuration.md | 10 ++++++---- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/config.sample b/config.sample index 66c38ac..1232585 100644 --- a/config.sample +++ b/config.sample @@ -24,10 +24,12 @@ transcode_cache_size = 1024 ; Optional rotating log file. Default: none log_file = /var/supysonic/supysonic.log -; Log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL. Default: WARNING +; Log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL. +; Default: WARNING log_level = WARNING -; Enable the Subsonic REST API. You'll most likely want to keep this on, here for testing purposes. Default: on +; Enable the Subsonic REST API. You'll most likely want to keep this on, here +; for testing purposes. Default: on ;mount_api = on ; Enable the administrative web interface. Default: on @@ -41,7 +43,8 @@ socket = /var/run/supysonic.sock ; Defines if the file watcher should be started. Default: yes run_watcher = yes -; Delay before triggering scanning operation after a change have been detected +; Delay in seconds before triggering scanning operation after a change have been +; detected. ; This prevents running too many scans when multiple changes are detected for a ; single file over a short time span. Default: 5 wait_delay = 5 diff --git a/docs/configuration.md b/docs/configuration.md index 3e825bd..ea9308a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -142,9 +142,10 @@ Default: /tmp/supysonic/supysonic.sock `run_watcher`: whether or not to start the watcher that will listen for library changes. Default: yes -`wait_delay`: delay before triggering the scanning operation after a change -have been detected. This prevents running too many scans when multiple changes -are detected for a single file over a short time span. Default: 5 seconds. +`wait_delay`: delay (in seconds) before triggering the scanning operation after +a change have been detected. This prevents running too many scans when multiple +changes are detected for a single file over a short time span. +Default: 5 seconds. `jukebox_command` : command used by the jukebox mode to play a single file. See the [jukebox documentation](jukebox.md) for more details. @@ -165,7 +166,8 @@ socket = /var/run/supysonic.sock ; Defines if the file watcher should be started. Default: yes run_watcher = yes -; Delay before triggering scanning operation after a change have been detected +; Delay in seconds before triggering scanning operation after a change have been +; detected. ; This prevents running too many scans when multiple changes are detected for a ; single file over a short time span. Default: 5 wait_delay = 5