Diff

mod_ping_muc/README.md @ 4804:a7c0c70e64b6

mod_ping_muc: Yet another attempt to improve MUC reliability This time by moving XEP-0410 to the server. Will this save the users from the s2s timeouts? What horrifying unintentional side-effects will this have? Tune in next week to find out!
author Kim Alvefur <zash@zash.se>
date Thu, 02 Dec 2021 23:43:11 +0100
child 4902:ed9aa80c989d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_ping_muc/README.md	Thu Dec 02 23:43:11 2021 +0100
@@ -0,0 +1,36 @@
+---
+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**