view mod_ping_muc/README.md @ 4811:a1fe59c06c48

mod_muc_rtbl: Fix typo in variable name in previous commit (thanks luacheck)
author Matthew Wild <mwild1@gmail.com>
date Mon, 06 Dec 2021 12:26:16 +0000
parents a7c0c70e64b6
children ed9aa80c989d
line wrap: on
line source

---
summary: Yet another MUC reliability module
rockspec:
  dependencies:
  - mod_track_muc_joins
labels:
- Stage-Alpha
...


This module reacts to [server-to-server][doc:s2s] connections closing by
performing [XEP-0410: MUC Self-Ping] from the server side to check if
users are still connected to MUCs they have joined according
[mod_track_muc_joins].  If it can't be confirmed than 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

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

# Compatibility

Requires prosody **trunk**