From 17432621585602dd7361224b9604e99a34e185ec Mon Sep 17 00:00:00 2001 From: Marcus B Spencer Date: Tue, 22 Apr 2025 11:31:51 -0500 Subject: [PATCH 1/2] chore(config): document options for auditing Adds documentation for the auditEnabled and auditFile config options. --- users/config.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/users/config.rst b/users/config.rst index 9a35a027..35e77499 100644 --- a/users/config.rst +++ b/users/config.rst @@ -1348,6 +1348,25 @@ The ``options`` element contains all other global configuration options. connections. The mechanism is described in detail in a :doc:`separate chapter `. +.. option:: options.auditEnabled + + When ``true``, analogous to :option:`--audit` being set. + Defaults to ``false``. + + Requires Syncthing to be restarted to take effect. + + When either this option, or :option:`--audit` (or both) are enabled, + auditing is enabled. + +.. option:: options.auditFile + + Analogous to :option:`--auditfile`. Defaults to being unset. + + Requires Syncthing to be restarted to take effect. + + For compatibility reasons, if both this option and :option:`--auditfile` + are set, :option:`--auditfile` takes priority. + Defaults Element ---------------- From 988ac2e4f2527ee8274a135b04dac73ea2a6a291 Mon Sep 17 00:00:00 2001 From: Marcus B Spencer Date: Fri, 9 May 2025 13:26:34 -0500 Subject: [PATCH 2/2] No need to document that restarting is required In a properly behaving Syncthing, the user will get a prompt if necessary. --- users/config.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/users/config.rst b/users/config.rst index d8ac5f38..49b2e59d 100644 --- a/users/config.rst +++ b/users/config.rst @@ -1354,8 +1354,6 @@ The ``options`` element contains all other global configuration options. When ``true``, analogous to :option:`--audit` being set. Defaults to ``false``. - Requires Syncthing to be restarted to take effect. - When either this option, or :option:`--audit` (or both) are enabled, auditing is enabled. @@ -1363,8 +1361,6 @@ The ``options`` element contains all other global configuration options. Analogous to :option:`--auditfile`. Defaults to being unset. - Requires Syncthing to be restarted to take effect. - For compatibility reasons, if both this option and :option:`--auditfile` are set, :option:`--auditfile` takes priority.