Software / code / prosody-modules
Annotate
mod_support_room/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 3426:f72aa8840042 |
| 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 |
