view mod_service_outage_status/README.markdown @ 5755:4a353ccce220

luacheckrc: Replace deprecated module:once with :on_ready So that :once is warned about properly. module:once was only added in trunk so it shouldn't have gotten very far yet.
author Kim Alvefur <zash@zash.se>
date Sat, 02 Dec 2023 11:10:43 +0100
parents 03044a6f5f4c
children
line wrap: on
line source

This module allows advertising a machine-readable document were outages,
planned or otherwise, may be reported.

See [XEP-0455: Service Outage Status] for further details, including
the format of the outage status document.

```lua
modules_enabled = {
    -- other modules
    "service_outage_status",
}

outage_status_urls = {
    "https://uptime.example.net/status.json",
}
```

The outage status document should be hosted on a separate server to
ensure availability even if the XMPP server is unreachable.