mod_service_outage_status/README.markdown
author Kim Alvefur <zash@zash.se>
Sat, 15 Jul 2023 10:45:26 +0200
changeset 5608 aab0023b51c9
parent 5342 03044a6f5f4c
permissions -rw-r--r--
editorconfig: Document established conventions

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.