annotate mod_support_room/README.markdown @ 4757:8e22b858628f

luacheck: Discourage use of the 'hosts' global (like in Prosody) Shorter name for prosody.hosts which is more explicit. Having fewer globals is better.
author Kim Alvefur <zash@zash.se>
date Sun, 07 Nov 2021 14:18:47 +0100
parents f72aa8840042
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3426
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module adds newly registered users as members to a specified MUC
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 room and sends them an invite. In a way, this is similar in purpose to
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 [mod_support_contact] and [mod_default_bookmarks].
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 # Example
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 VirtualHost"example.com"
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 modules_enabled = { "support_room" }
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 support_room = "room@muc.example.com"
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 support_room_inviter = "support@example.com"
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 support_room_reason = "Invite new users to the support room"
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 Component "muc.example.com"
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 # Compatibility
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 This module
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 Version Works
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 --------- -------
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 0.11.x Yes
f72aa8840042 mod_support_room: Module that invites newly registered users to a room
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 0.10.x No