Mercurial > prosody-modules

annotate mod_muc_invite_remote_affiliated_jids/README.md @ 6561:93544117ddcd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
muc_invite_remote_affiliated_jids: new module
author nicoco <nicoco@nicoco.fr>
date Mon, 08 Jun 2026 22:42:05 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6561
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
1 ---
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
2 labels:
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
3 - 'Stage-Alpha'
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
4 summary: 'Send invites to MUC affiliated remote JIDs on startup'
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
5 ...
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
6
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
7 Purpose
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
8 =======
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
9
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
10 This module sends invites to non-local JIDs that are affiliated as "member",
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
11 "owner" or "admin" of rooms. It is a workaround for situations where
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
12 participants are kicked of a room by a server shutdown, to signal to their
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
13 client that they can join the room again.
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
14
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
15 Configuration
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
16 =============
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
17
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
18 Add the module to the MUC host (not the global modules\_enabled):
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
19
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
20 ```lua
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
21 Component "conference.example.com" "muc"
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
22 modules_enabled = { "muc_invite_remote_affiliated_jids" }
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
23 ```
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
24
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
25 You can configure a message associated to the invite with the
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
26 `muc_invite_remote_affiliated_jids_reason` configuration entry.
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
27
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
28 Compatibility
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
29 =============
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
30
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
31 ------- -------
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
32 trunk* Works
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
33 ------- -------
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
34
93544117ddcd muc_invite_remote_affiliated_jids: new module
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
35 *as of 2026-06-08