annotate mod_muc_ping/README.markdown @ 5183:3b5358934d15

mod_s2s_blacklist/README: Show inclusion in modules_enabled in example Thanks amalgame21
author Kim Alvefur <zash@zash.se>
date Thu, 02 Mar 2023 11:38:08 +0100
parents 59bedf167910
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4960
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
1 ---
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
2 labels:
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
3 - 'Stage-Obsolete'
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
4 superseded_by: mod_muc
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
5 summary: XEP-0410 Server Optimization (now supported by Prosody mod_muc)
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
6 ---
59bedf167910 mod_muc_ping: Remove since Prosody mod_muc 0.11+ covers this natively
Kim Alvefur <zash@zash.se>
parents: 3381
diff changeset
7
3349
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 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
9 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
10 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
11
3356
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
12 # Usage
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 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
15
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
16 ```lua
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
17 Component "muc.example.com" "muc"
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
18 modules_enabled = {
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
19 "muc_ping";
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
20 }
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
21 ```
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
22
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
23 # Configuration
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
24
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
25 No options.
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
26
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
27 # Compatibility
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3349
diff changeset
28
3349
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 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
30
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
31 Prosody 0.11.x and trunk natively supports XEP-0410 so this module is **not** needed.