diff mod_muc_invite_remote_affiliated_jids/README.md @ 6561:93544117ddcd

muc_invite_remote_affiliated_jids: new module
author nicoco <nicoco@nicoco.fr>
date Mon, 08 Jun 2026 22:42:05 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_invite_remote_affiliated_jids/README.md	Mon Jun 08 22:42:05 2026 +0200
@@ -0,0 +1,35 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'Send invites to MUC affiliated remote JIDs on startup'
+...
+
+Purpose
+=======
+
+This module sends invites to non-local JIDs that are affiliated as "member",
+"owner" or "admin" of rooms. It is a workaround for situations where
+participants are kicked of a room by a server shutdown, to signal to their
+client that they can join the room again.
+
+Configuration
+=============
+
+Add the module to the MUC host (not the global modules\_enabled):
+
+```lua
+Component "conference.example.com" "muc"
+    modules_enabled = { "muc_invite_remote_affiliated_jids" }
+```
+
+You can configure a message associated to the invite with the
+`muc_invite_remote_affiliated_jids_reason` configuration entry.
+
+Compatibility
+=============
+
+  ------- -------
+  trunk*  Works
+  ------- -------
+
+*as of 2026-06-08