view mod_muc_ping/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 59bedf167910
children
line wrap: on
line source

---
labels:
- 'Stage-Obsolete'
superseded_by: mod_muc
summary: XEP-0410 Server Optimization (now supported by Prosody mod_muc)
---

This module implements the [Server
Optimization](https://xmpp.org/extensions/xep-0410.html#serveroptimization)
part of [XEP-0410: MUC Self-Ping]

# Usage

The module is loaded on MUC components:

```lua
Component "muc.example.com" "muc"
modules_enabled = {
    "muc_ping";
}
```

# Configuration

No options.

# Compatibility

It should work with Prosody up until 0.10.x.

Prosody 0.11.x and trunk natively supports XEP-0410 so this module is **not** needed.