Diff

mod_support_room/README.markdown @ 3426:f72aa8840042

mod_support_room: Module that invites newly registered users to a room
author Kim Alvefur <zash@zash.se>
date Thu, 03 Jan 2019 12:06:09 +0100
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_support_room/README.markdown	Thu Jan 03 12:06:09 2019 +0100
@@ -0,0 +1,24 @@
+# Introduction
+
+This module adds newly registered users as members to a specified MUC
+room and sends them an invite. In a way, this is similar in purpose to
+[mod_support_contact] and [mod_default_bookmarks].
+
+# Example
+
+    VirtualHost"example.com"
+        modules_enabled = { "support_room" }
+        support_room = "room@muc.example.com"
+        support_room_inviter = "support@example.com"
+        support_room_reason = "Invite new users to the support room"
+
+    Component "muc.example.com"
+
+# Compatibility
+
+This module
+
+  Version   Works
+  --------- -------
+  0.11.x    Yes
+  0.10.x    No