1 #summary Prevent registration of user accounts according to policies

     2 #labels Stage-Beta

     3 

     4 = Introduction =

     5 

     6 On a server with public registration it is usually desirable to prevent registration of certain "reserved" accounts, such as "admin".

     7 

     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.

     9 

    10 = Configuration =

    11 

    12 Enable the module as any other:

    13 

    14 {{{

    15     modules_enabled = {

    16         "block_registrations";

    17     }

    18 }}}

    19 

    20 You can then set some options to configure your desired policy:

    21 

    22 || *Option* || *Default* || *Description* ||

    23 || block_registrations_users || { "admin" } || A list of reserved usernames ||

    24 || block_registrations_matching || { } || A list of [http://www.lua.org/manual/5.1/manual.html#5.4.1 Lua patterns] matching reserved usernames (slower than block_registrations_users) ||

    25 || block_registrations_allow || nil || A pattern that registered user accounts MUST match to be allowed ||

    26 

    27 Some examples:

    28 

    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 

    37 = Compatibility =

    38 || 0.9 || Works ||

    39 || 0.8 || Should work ||