prosody-modules
d194d1012fd3
mod_audit_status/README.md
Software / code / prosody-modules
File
mod_audit_status/README.md @ 5931: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 |
| parent | 5320:c450dbf6c0fa |
line wrap: on
line source
--- summary: Log server status changes to audit log rockspec: {} ... This module records server status (start, stop, crash) to the audit log maintained by [mod_audit]. ## Configuration There is a single option, `audit_status_heartbeat_interval` which specifies the interval at which the "server is running" heartbeat should be updated (it is stored in Prosody's configured storage backend). To detect crashes, Prosody periodically updates this value at the specified interval. A low value will update more frequently, which causes additional I/O for Prosody. A high value will give less accurate timestamps for "server crashed" events in the audit log. The default value is 60 (seconds). ```lua audit_status_heartbeat_interval = 60 ``` ## Compatibility This module requires Prosody trunk (as of April 2023). It is not compatible with 0.12.
