Mercurial > prosody-modules
annotate mod_muc_ping/README.markdown @ 5951:d6a695abb33c
mod_ping_muc: Delay ping a configurable amount of time
If a server is restarting, checking immediately before it has a chance
to complete its restart and get ready would often fail, preventing the
possibility of transparent restarts as supported by Prosody's mod_muc.
Reconnecting immediately when a connection is closed for being idle, or
because the remote server is trying to reclaim some resources, is also
counter-productive as the connection may fail.
Also, if there is some Internet routing problem affecting s2s, it may
help to wait a bit before checking, in case the problem resolved itself
in the mean time.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 11 Aug 2024 16:10:24 +0200 |
parents | 59bedf167910 |
children |
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. |