Mercurial > prosody-modules
view mod_service_outage_status/README.markdown @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -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.