view mod_service_outage_status/README.markdown @ 5908:dcea4b4c415d

Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.
author Ben Smith <bens@effortlessis.com>
date Tue, 14 May 2024 07:31:34 -0700
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.