Mercurial > prosody-modules

comparison mod_audit/README.md @ 5326:dc058fcc3fe3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_audit: Improve filtering options and add documentation to README
author Matthew Wild <mwild1@gmail.com>
date Fri, 07 Apr 2023 13:44:18 +0100
parents 530d116b7f68
children 561503e0c0f1
comparison
equal deleted inserted replaced
5325:11b37063d80a 5326:dc058fcc3fe3
23 23
24 Before using these modules, you may want to ensure that you are legally 24 Before using these modules, you may want to ensure that you are legally
25 allowed to store the data for the amount of time these modules will store it. 25 allowed to store the data for the amount of time these modules will store it.
26 Note that it is currently not possible to store different event types with 26 Note that it is currently not possible to store different event types with
27 different expiration times. 27 different expiration times.
28
29 ## Viewing the log
30
31 You can view the log using prosodyctl. This works even when Prosody is not
32 running.
33
34 For example, to view the full audit log for example.com:
35
36 ```shell
37 prosodyctl mod_audit example.com
38 ```
39
40 To view only host-wide events (those not attached to a specific user account),
41 use the `--global` option (or use `--no-global` to hide such events):
42
43 ```shell
44 prosodyctl mod_audit --global example.com
45 ```
46
47 To narrow results to a specific user, specify their JID:
48
49 ```shell
50 prosodyctl mod_audit user@example.com
51 ```