Mercurial > prosody-modules

annotate mod_service_outage_status/README.markdown @ 5338:03044a6f5f4c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_service_outage_status: XEP-0455: Service Outage Status Only the out of band part so far. The in-band pubsub part would need '+notify' support in mod_pubsub, since mod_pep does not serve the bare-host-JID. All the hard parts of this XEP is elsewhere, i.e. hosting the document somewhere reliable.
author Kim Alvefur <zash@zash.se>
date Mon, 10 Apr 2023 13:24:03 +0200
parents
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.