From 55e9db61d81c5da9653eea438991ef3db962f7c1 Mon Sep 17 00:00:00 2001 From: spl0k Date: Sat, 13 Apr 2019 16:53:37 +0200 Subject: [PATCH] Docs update --- config.sample | 4 ++++ docs/configuration.md | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/config.sample b/config.sample index 14579da..66f3162 100644 --- a/config.sample +++ b/config.sample @@ -31,6 +31,10 @@ log_level = WARNING ;mount_webui = on [daemon] +; Socket file the daemon will listen on for incoming management commands +; Default: /tmp/supysonic/supysonic.sock +socket = /var/run/supysonic.sock + ; Delay 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 diff --git a/docs/configuration.md b/docs/configuration.md index 2cd13de..a52d64e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -127,6 +127,11 @@ log_level = WARNING ## `[daemon]` section +`socket`: Unix domain socket file (or named pipe on Windows) used to communicate +between the daemon and clients that rely on it (eg. CLI, folder admin web page, +etc.). Note that using an IP address here isn't supported. +Default: /tmp/supysonic/supysonic.sock + `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. @@ -140,6 +145,10 @@ If left empty, any logging will be sent to stderr. ```ini [daemon] +; Socket file the daemon will listen on for incoming management commands +; Default: /tmp/supysonic/supysonic.sock +socket = /var/run/supysonic.sock + ; Delay 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