Mercurial > prosody-modules

comparison mod_block_registrations/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_block_registrations/README.wiki@29f3d6b7ad16
children 65d9093525ca
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 Introduction
2 ============
3
4 On a server with public registration it is usually desirable to prevent
5 registration of certain "reserved" accounts, such as "admin".
6
7 This plugin allows you to reserve individual usernames, or those
8 matching certain patterns. It also allows you to ensure that usernames
9 conform to a certain pattern.
10
11 Configuration
12 =============
13
14 Enable the module as any other:
15
16 modules_enabled = {
17 "block_registrations";
18 }
19
20 You can then set some options to configure your desired policy:
21
22 Option Default Description
23 -------------------------------- --------------- -------------------------------------------------------------------------------------------------------------------------------------------------
24 block\_registrations\_users `{ "admin" }` A list of reserved usernames
25 block\_registrations\_matching `{ }` A list of [Lua patterns](http://www.lua.org/manual/5.1/manual.html#5.4.1) matching reserved usernames (slower than block\_registrations\_users)
26 block\_registrations\_allow `nil` A pattern that registered user accounts MUST match to be allowed
27
28 Some examples:
29
30 block_registrations_users = { "admin", "root", "xmpp" }
31 block_registrations_matching = {
32 "master$" -- matches anything ending with master: postmaster, hostmaster, webmaster, etc.
33 }
34 block_registrations_allow = "^[a-zA-Z0-9_-.]$" -- Allow only simple ASCII characters in usernames
35
36 Compatibility
37 =============
38
39 ----- -------------
40 0.9 Works
41 0.8 Should work
42 ----- -------------
43
44