mod_ping_muc

This module reacts to server-to-server connections closing by performing XEP-0410: MUC Self-Ping from the server side after a short delay to check if users are still connected to MUCs they have joined according mod_track_muc_joins. If it can’t be confirmed that the user is still joined then their client devices are notified about this allowing them to re-join.

Installing

prosodyctl install mod_ping_muc

Configuring

Enable as a regular module in modules_enabled globally or under a VirtualHost:

modules_enabled = {
    -- other modules etc
    "track_muc_joins",
    "ping_muc",
}

The delay after which pings are sent can be adjusted with the setting ping_muc_delay, from the default 60 (seconds).

Client facing protocol

If the module determines that the client has dropped out a MUC, it sends it a stanza to indicate this:

<presence type="unavailable" id="random123" from="room@muc.host/nickname" to="user@example.net/resource">
  <x xmlns="http://jabber.org/protocol/muc#user">
    <item affiliation="none" role="none">
      <reason>Connection to remote server lost</reason>
    </item>
    <status code="110"/>
    <status code="330"/>
  </x>
</presence>

The reason message may vary.

Upon receiving this, the client may attempt to rejoin.

Compatibility

Requires Prosody 0.12.x or trunk

Installation

With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_ping_muc

For earlier versions see the documentation for installing 3rd party modules

Latest changes