Mercurial > prosody-wiki

annotate mod_block_registrations.wiki @ 459:7261117fcf19

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Link to Zash's guide
author MWild1@gmail.com
date Mon, 19 May 2014 10:31:17 +0000
parents 26ac8c0e6ecf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
358
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Prevent registration of user accounts according to policies
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Beta
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 On a server with public registration it is usually desirable to prevent registration of certain "reserved" accounts, such as "admin".
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 This plugin allows you to reserve individual usernames, or those matching certain patterns. It also allows you to ensure that usernames conform to a certain pattern.
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 = Configuration =
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 Enable the module as any other:
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 {{{
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15 modules_enabled = {
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 "block_registrations";
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 }
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18 }}}
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20 You can then set some options to configure your desired policy:
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 || *Option* || *Default* || *Description* ||
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23 || block_registrations_users || { "admin" } || A list of reserved usernames ||
431
0bf555b3a3fa mod_block_registrations: block_registrations_matching, not _patterns
Kim Alvefur <zash@zash.se>
parents: 358
diff changeset
24 || block_registrations_matching || { } || A list of patterns matching reserved usernames (slower than block_registrations_users) ||
358
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25 || block_registrations_allow || nil || A pattern that registered user accounts MUST match to be allowed ||
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27 Some examples:
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29 {{{
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 block_registrations_users = { "admin", "root", "xmpp" }
432
26ac8c0e6ecf and there too
Kim Alvefur <zash@zash.se>
parents: 431
diff changeset
31 block_registrations_matching = {
358
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32 "master$" -- matches postmaster, hostmaster, webmaster, etc.
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
33 }
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
34 block_registrations_allow = "^[a-zA-Z0-9_-.]$" -- Allow only simple ASCII characters in usernames
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
35 }}}
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
36
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
37 = Compatibility =
f90471dee368 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
38 || 0.9 || Works ||
431
0bf555b3a3fa mod_block_registrations: block_registrations_matching, not _patterns
Kim Alvefur <zash@zash.se>
parents: 358
diff changeset
39 || 0.8 || Should work ||