annotate mod_audit_user_accounts/README.md @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 628952e4ff47
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4933
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
1 ---
5745
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
2 summary: Store user account lifecycle events in the audit log
4933
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
3 rockspec:
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
4 dependencies:
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
5 - mod_audit
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
6 ...
530d116b7f68 mod_audit*: modules for audit logging in prosody
Jonas Schäfer <jonas@wielicki.name>
parents:
diff changeset
7
5745
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
8 This module stores events related to user accounts in the audit log. Events
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
9 include:
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
10
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
11 - New user registered via IBR (user-registered)
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
12 - User deleted their account via IBR (user-deregistered)
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
13 - User requested deletion of their account (i.e. when a grace period is set) (user-deregistered-pending)
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
14 - User account disabled
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
15 - User account enabled
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
16
628952e4ff47 mod_audit_user_accounts: Renamed from mod_audit_register
Matthew Wild <mwild1@gmail.com>
parents: 4933
diff changeset
17 There are no configuration options for this module. It depends on mod_audit.