prosody-modules
d60e04d3996e
mod_ping_muc/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_ping_muc/README.md @ 5980:d60e04d3996e

mod_ping_muc: Update docs for ping delay
author Kim Alvefur <zash@zash.se>
date Sun, 11 Aug 2024 16:19:37 +0200
parent 5957:c094eabdb30f
comparison
equal deleted inserted replaced
5979:d6a695abb33c 5980:d60e04d3996e
7 - Stage-Alpha 7 - Stage-Alpha
8 ... 8 ...
9 9
10 10
11 This module reacts to [server-to-server][doc:s2s] connections closing by 11 This module reacts to [server-to-server][doc:s2s] connections closing by
12 performing [XEP-0410: MUC Self-Ping] from the server side to check if 12 performing [XEP-0410: MUC Self-Ping] from the server side after a short delay to check if
13 users are still connected to MUCs they have joined according 13 users are still connected to MUCs they have joined according
14 [mod_track_muc_joins]. If it can't be confirmed that the user is still 14 [mod_track_muc_joins]. If it can't be confirmed that the user is still
15 joined then their client devices are notified about this allowing them 15 joined then their client devices are notified about this allowing them
16 to re-join. 16 to re-join.
17 17
21 prosodyctl install mod_ping_muc 21 prosodyctl install mod_ping_muc
22 ``` 22 ```
23 23
24 # Configuring 24 # Configuring
25 25
26 No configuration. Enable as a regular module in 26 Enable as a regular module in
27 [`modules_enabled`][doc:modules_enabled] globally or under a 27 [`modules_enabled`][doc:modules_enabled] globally or under a
28 `VirtualHost`: 28 `VirtualHost`:
29 29
30 ```lua 30 ```lua
31 modules_enabled = { 31 modules_enabled = {
32 -- other modules etc 32 -- other modules etc
33 "track_muc_joins", 33 "track_muc_joins",
34 "ping_muc", 34 "ping_muc",
35 } 35 }
36 ``` 36 ```
37
38 The delay after which pings are sent can be adjusted with the setting `ping_muc_delay`,
39 from the default `60` (seconds).
37 40
38 # Client facing protocol 41 # Client facing protocol
39 42
40 If the module determines that the client has dropped out a MUC, 43 If the module determines that the client has dropped out a MUC,
41 it sends it [a stanza to indicate this](https://xmpp.org/extensions/xep-0045.html#service-error-kick): 44 it sends it [a stanza to indicate this](https://xmpp.org/extensions/xep-0045.html#service-error-kick):