Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_config_restrict/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,44 @@
+#summary Restrict MUC configuration options to server admins
+#labels Stage-Alpha
+
+= Introduction =
+
+Sometimes, especially on public services, you may want to allow people to create their own rooms, but prevent some options from being modified by normal users.
+
+For example, using this module you can prevent users from making rooms persistent, or making rooms publicly visible.
+
+= Details =
+
+You need to supply a list of options that will be restricted to admins. Available options can vary, but the following table lists Prosody's built-in options (as defined in XEP-0045):
+
+|| *Name* || *Description* ||
+|| muc#roomconfig_roomname || The title/name of the room ||
+|| muc#roomconfig_roomdesc || The description of the room ||
+|| muc#roomconfig_persistentroom || Whether the room should remain when empty ||
+|| muc#roomconfig_publicroom || Whether the room is publicly visible ||
+|| muc#roomconfig_changesubject || Whether occupants can change the subject ||
+|| muc#roomconfig_whois || Control who can see occupant's real JIDs ||
+|| muc#roomconfig_roomsecret || The room password ||
+|| muc#roomconfig_moderatedroom || Whether the room is moderated ||
+|| muc#roomconfig_membersonly || Whether the room is members-only ||
+|| muc#roomconfig_historylength || The length of the room history ||
+
+Some plugins may add other options to the room config (in Prosody 0.10+), for which you will need to consult their documentation for the full option name.
+
+= Configuration =
+
+Enable the plugin on a MUC host (do not put it in your global modules_enabled list):
+
+{{{
+    Component "conference.example.com" "muc"
+        modules_enabled = { "muc_config_restrict" }
+        muc_config_restricted = {
+            "muc#roomconfig_persistentroom"; -- Prevent non-admins from changing a room's persistence setting
+            "muc#roomconfig_membersonly"; -- Prevent non-admins from changing whether rooms are members-only
+        }
+}}}
+
+= Compatibility =
+|| trunk || Works ||
+|| 0.9 || Doesn't work ||
+|| 0.8 || Doesn't work ||
\ No newline at end of file