Mercurial > prosody-modules

comparison mod_muc_restrict_rooms/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_muc_restrict_rooms/README.wiki@29f3d6b7ad16
children 34fb3d239ac1
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 summary: Regexp based room restriction module
3 ...
4
5 Introduction
6 ============
7
8 This module allows disabling room creation based on regexp patterns
9 defined in configuration.
10
11 Dependencies
12 ============
13
14 This module depends on **muc/rooms** module. If **muc/rooms** is not
15 loaded, this module won't work.
16
17 How to load the module
18 ======================
19
20 Copy the module to the prosody modules/plugins directory.
21
22 In Prosody's configuration file, under the desired MUC component
23 definition, add:
24
25 modules_enabled = {
26 ...
27 "mod_muc_restrict_rooms";
28 ...
29 }
30
31 **Note**: This module *shouldn't* be loaded in the global
32 **modules\_enabled**, otherwise it won't work.
33
34 Configuration
35 =============
36
37 **mod\_muc\_restrict\_rooms** has several variables which let you
38 configure the patterns for room names you want to ban, establish
39 exceptions for those patterns and even deciding whether admins can or
40 not bypass the prohibition.
41
42 Name Description Example Default value
43 ------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------- ---------------
44 muc\_restrict\_matching Table in the key/value format (keys for patterns and values for reasons) that determines which rooms shouldn't be created. The key is a regexp and must be specified between quotation marks (see example). Room names will be evaluated always lowercase, so define your patterns taking this into consideration. Users that try to join any room that matches one of those rules will get an error telling them they cannot join. muc\_restrict\_matching = { ["\^admin"] = "Rooms that start with 'admin' are reserved for staff use only" } {}
45 muc\_restrict\_exceptions String format table that contains exceptions to the above defined rules. Room names specified here will bypass the muc\_restrict\_matching restrictions and will be available for anyone muc\_restrict\_exceptions = { "admins\_are\_good", "admins\_rocks" } {}
46 muc\_restrict\_allow\_admins Boolean that determines whether users in the **admin** table are able to bypass any room restriction. If ser to *true*, they will be able to bypass those rules. muc\_restrict\_allow\_admins = true false
47
48 Compatibility
49 =============
50
51 ----- -------------
52 0.9 Works
53 0.8 Should work
54 ----- -------------