view mod_block_registrations.wiki @ 455:5f111a4e13fb

mod_s2s_auth_dane.wiki: drep mention of luajit, not required anymore
author Kim Alvefur <zash@zash.se>
date Mon, 19 May 2014 11:28:47 +0200
parents 26ac8c0e6ecf
children
line wrap: on
line source

#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 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 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 ||