Skip to content

Commit bd61896

Browse files
authored
chore(config): document options for audit logs (#916)
Adds documentation for the auditEnabled and auditFile config options in syncthing/syncthing#10066.
1 parent 6d312f2 commit bd61896

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

users/config.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1349,6 +1349,21 @@ The ``options`` element contains all other global configuration options.
13491349
connections. The mechanism is described in detail in a :doc:`separate
13501350
chapter </advanced/option-connection-limits>`.
13511351

1352+
.. option:: options.auditEnabled
1353+
1354+
When ``true``, analogous to :option:`--audit` being set.
1355+
Defaults to ``false``.
1356+
1357+
When either this option, or :option:`--audit` (or both) are enabled,
1358+
auditing is enabled.
1359+
1360+
.. option:: options.auditFile
1361+
1362+
Analogous to :option:`--auditfile`. Defaults to being unset.
1363+
1364+
For compatibility reasons, if both this option and :option:`--auditfile`
1365+
are set, :option:`--auditfile` takes priority.
1366+
13521367
Defaults Element
13531368
----------------
13541369

0 commit comments

Comments
 (0)