Skip to content

chore(config): document options for audit logs #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 26, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions users/config.rst
Original file line number Diff line number Diff line change
@@ -1349,6 +1349,21 @@ The ``options`` element contains all other global configuration options.
connections. The mechanism is described in detail in a :doc:`separate
chapter </advanced/option-connection-limits>`.

.. option:: options.auditEnabled

When ``true``, analogous to :option:`--audit` being set.
Defaults to ``false``.

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.

For compatibility reasons, if both this option and :option:`--auditfile`
are set, :option:`--auditfile` takes priority.

Defaults Element
----------------