Mercurial > prosody-modules

annotate mod_muc_ping/README.markdown @ 4776:13e913471b75

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_admin_api: Ensure freshness of metrics when in manual mode When in manual collection mode, as recommended for Prometheus, collection needs to be triggered manually, or they would be stale, possibly dating from the start of the server. This might vary per metric depending on how and when the metrics are gathered.
author Kim Alvefur <zash@zash.se>
date Thu, 18 Nov 2021 19:26:07 +0100
parents 861ddc74edd9
children 59bedf167910
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3349
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 This module implements the [Server
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 Optimization](https://xmpp.org/extensions/xep-0410.html#serveroptimization)
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 part of [XEP-0410: MUC Self-Ping]
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
3356
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
5 # Usage
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
6
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
7 The module is loaded on MUC components:
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
8
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
9 ```lua
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
10 Component "muc.example.com" "muc"
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
11 modules_enabled = {
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
12 "muc_ping";
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
13 }
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
14 ```
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
15
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
16 # Configuration
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
17
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
18 No options.
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
19
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
20 # Compatibility
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
21
3349
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 It should work with Prosody up until 0.10.x.
3356
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
23
3381
861ddc74edd9 mod_muc_ping: Update README to mention 0.11.x as separate from trunk
Kim Alvefur <zash@zash.se>
parents: 3356
diff changeset
24 Prosody 0.11.x and trunk natively supports XEP-0410 so this module is **not** needed.