Software / code / prosody-modules
Annotate
mod_audit_status/README.md @ 5401:c8d04ac200fc
mod_http_oauth2: Reject loopback URIs as client_uri
This really should be a proper website with info, https://localhost is
not good enough. Ideally we'd validate that it's got proper DNS and is
actually reachable, but triggering HTTP or even DNS lookups seems like
it would carry abuse potential that would best to avoid.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 02 May 2023 16:20:55 +0200 |
| parent | 5320:c450dbf6c0fa |
| rev | line source |
|---|---|
|
5320
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 summary: Log server status changes to audit log |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 rockspec: {} |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 ... |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 This module records server status (start, stop, crash) to the audit log |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 maintained by [mod_audit]. |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 ## Configuration |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 There is a single option, `audit_status_heartbeat_interval` which specifies |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 the interval at which the "server is running" heartbeat should be updated (it |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 is stored in Prosody's configured storage backend). |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 To detect crashes, Prosody periodically updates this value at the specified |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 interval. A low value will update more frequently, which causes additional I/O |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 for Prosody. A high value will give less accurate timestamps for "server |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 crashed" events in the audit log. |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 The default value is 60 (seconds). |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 ```lua |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 audit_status_heartbeat_interval = 60 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 ``` |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 ## Compatibility |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 This module requires Prosody trunk (as of April 2023). It is not compatible |
|
c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 with 0.12. |
