prosody-modules
4d73a1a6ba68
mod_muc_config_restrict/README.markdown
Software / code / prosody-modules
Comparison
mod_muc_config_restrict/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 18:03:58 +0200 |
| parent | 1782:mod_muc_config_restrict/README.wiki@29f3d6b7ad16 |
| child | 1820:8de50be756e5 |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: Restrict MUC configuration options to server admins | |
| 5 ... | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 Sometimes, especially on public services, you may want to allow people | |
| 11 to create their own rooms, but prevent some options from being modified | |
| 12 by normal users. | |
| 13 | |
| 14 For example, using this module you can prevent users from making rooms | |
| 15 persistent, or making rooms publicly visible. | |
| 16 | |
| 17 Details | |
| 18 ======= | |
| 19 | |
| 20 You need to supply a list of options that will be restricted to admins. | |
| 21 Available options can vary, but the following table lists Prosody's | |
| 22 built-in options (as defined in XEP-0045): | |
| 23 | |
| 24 Name Description | |
| 25 --------------------------------- ------------------------------------------- | |
| 26 muc\#roomconfig\_roomname The title/name of the room | |
| 27 muc\#roomconfig\_roomdesc The description of the room | |
| 28 muc\#roomconfig\_persistentroom Whether the room should remain when empty | |
| 29 muc\#roomconfig\_publicroom Whether the room is publicly visible | |
| 30 muc\#roomconfig\_changesubject Whether occupants can change the subject | |
| 31 muc\#roomconfig\_whois Control who can see occupant's real JIDs | |
| 32 muc\#roomconfig\_roomsecret The room password | |
| 33 muc\#roomconfig\_moderatedroom Whether the room is moderated | |
| 34 muc\#roomconfig\_membersonly Whether the room is members-only | |
| 35 muc\#roomconfig\_historylength The length of the room history | |
| 36 | |
| 37 Some plugins may add other options to the room config (in Prosody | |
| 38 0.10+), for which you will need to consult their documentation for the | |
| 39 full option name. | |
| 40 | |
| 41 Configuration | |
| 42 ============= | |
| 43 | |
| 44 Enable the plugin on a MUC host (do not put it in your global | |
| 45 modules\_enabled list): | |
| 46 | |
| 47 Component "conference.example.com" "muc" | |
| 48 modules_enabled = { "muc_config_restrict" } | |
| 49 muc_config_restricted = { | |
| 50 "muc#roomconfig_persistentroom"; -- Prevent non-admins from changing a room's persistence setting | |
| 51 "muc#roomconfig_membersonly"; -- Prevent non-admins from changing whether rooms are members-only | |
| 52 } | |
| 53 | |
| 54 Compatibility | |
| 55 ============= | |
| 56 | |
| 57 ------- -------------- | |
| 58 trunk Works | |
| 59 0.9 Doesn't work | |
| 60 0.8 Doesn't work | |
| 61 ------- -------------- |
