annotate mod_muc_config_restrict.wiki @ 471:5fbe553241a8

Created wiki page through web user interface.
author MWild1@gmail.com
date Sun, 27 Jul 2014 14:22:08 +0000
parents c8aca35f36df
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
354
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Restrict MUC configuration options to server admins
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 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.
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 For example, using this module you can prevent users from making rooms persistent, or making rooms publicly visible.
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 = Details =
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 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):
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 || *Name* || *Description* ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15 || muc#roomconfig_roomname || The title/name of the room ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 || muc#roomconfig_roomdesc || The description of the room ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 || muc#roomconfig_persistentroom || Whether the room should remain when empty ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18 || muc#roomconfig_publicroom || Whether the room is publicly visible ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19 || muc#roomconfig_changesubject || Whether occupants can change the subject ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20 || muc#roomconfig_whois || Control who can see occupant's real JIDs ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21 || muc#roomconfig_roomsecret || The room password ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 || muc#roomconfig_moderatedroom || Whether the room is moderated ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23 || muc#roomconfig_membersonly || Whether the room is members-only ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24 || muc#roomconfig_historylength || The length of the room history ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26 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.
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28 = Configuration =
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 Enable the plugin on a MUC host (do not put it in your global modules_enabled list):
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
31
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32 {{{
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
33 Component "conference.example.com" "muc"
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
34 modules_enabled = { "muc_config_restrict" }
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
35 muc_config_restricted = {
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
36 "muc#roomconfig_persistentroom"; -- Prevent non-admins from changing a room's persistence setting
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
37 "muc#roomconfig_membersonly"; -- Prevent non-admins from changing whether rooms are members-only
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
38 }
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
39 }}}
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
40
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
41 = Compatibility =
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
42 || trunk || Works ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
43 || 0.9 || Doesn't work ||
c8aca35f36df Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
44 || 0.8 || Doesn't work ||