File

#summary Prevent registration of user accounts according to policies
#labels Stage-Beta

= Introduction =

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

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.

= Configuration =

Enable the module as any other:

{{{
    modules_enabled = {
        "block_registrations";
    }
}}}

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

|| *Option* || *Default* || *Description* ||
|| block_registrations_users || { "admin" } || A list of reserved usernames ||
|| 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) ||
|| block_registrations_allow || nil || A pattern that registered user accounts MUST match to be allowed ||

Some examples:

{{{
    block_registrations_users = { "admin", "root", "xmpp" }
    block_registrations_matching = {
        "master$" -- matches anything ending with master: postmaster, hostmaster, webmaster, etc.
    }
    block_registrations_allow = "^[a-zA-Z0-9_-.]$" -- Allow only simple ASCII characters in usernames
}}}

= Compatibility =
|| 0.9 || Works ||
|| 0.8 || Should work ||