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.

Sign up for GitHub

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
calmh merged 7 commits into from
May 26, 2025
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1743262
chore(config): document options for auditing
marbens-arch Apr 22, 2025
42a984b
Merge branch 'main' into audit-mode-config
marbens-arch Apr 22, 2025
66c9cd0
Merge branch 'main' into audit-mode-config
marbens-arch Apr 25, 2025
c385746
Merge branch 'main' into audit-mode-config
marbens-arch Apr 26, 2025
5c51fc7
Merge branch 'main' into audit-mode-config
marbens-arch May 9, 2025
988ac2e
No need to document that restarting is required
marbens-arch May 9, 2025
cd33587
Merge branch 'main' into audit-mode-config
marbens-arch May 26, 2025
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------

Expand Down