annotate mod_support_room/README.markdown @ 4651:8231774f5bfd

mod_cloud_notify_encrypted: Ensure body substring remains valid UTF-8 The `body:sub()` call risks splitting the string in the middle of a multi-byte UTF-8 sequence. This should have been caught by util.stanza validation, but that would have caused some havoc, at the very least causing the notification to not be sent. There have been no reports of this happening. Likely because this module isn't widely deployed among users with languages that use many longer UTF-8 sequences. The util.encodings.utf8.valid() function is O(n) where only the last sequence really needs to be checked, but it's in C and expected to be fast.
author Kim Alvefur <zash@zash.se>
date Sun, 22 Aug 2021 13:22:59 +0200
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