view mod_service_outage_status/README.markdown @ 5440:82a14082be3f

mod_auth_oauth_external: Allow different username in PLAIN vs final JID Mastodon for example having email addresses usernames in login, but a different username in the service itself. Thanks to @tcit@social.tcit.fr for the pointer to a usable validation endpoint for Mastodon, allowing this to be tested.
author Kim Alvefur <zash@zash.se>
date Wed, 10 May 2023 13:52:31 +0200
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.