Mercurial > prosody-modules

annotate mod_service_outage_status/README.markdown @ 5853:97c9b76867ca

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_log_ringbuffer: Detach event handlers on logging reload (thanks Menel) Otherwise the global event handlers accumulate, one added each time logging is reoladed, and each invocation of the signal or event triggers one dump of each created ringbuffer.
author Kim Alvefur <zash@zash.se>
date Sun, 03 Mar 2024 11:23:40 +0100
parents 03044a6f5f4c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5338
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 This module allows advertising a machine-readable document were outages,
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 planned or otherwise, may be reported.
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 See [XEP-0455: Service Outage Status] for further details, including
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 the format of the outage status document.
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ```lua
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 modules_enabled = {
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 -- other modules
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 "service_outage_status",
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 }
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 outage_status_urls = {
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 "https://uptime.example.net/status.json",
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 }
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 ```
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 The outage status document should be hosted on a separate server to
03044a6f5f4c mod_service_outage_status: XEP-0455: Service Outage Status
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 ensure availability even if the XMPP server is unreachable.