File

mod_block_registrations/README.markdown @ 5997:d3812826c1cd

mod_csi_muc_priorities: Allow setting the default priority for mucs to low Move the priority checking after the mention check so that if there is a mention we return true. Add an option to the form to set the default priority to low. Return `nil` in cases where we determite that the priority should be high, as with `mod_csi_simple` this causes normal MUC messages to be marked important while allowing mod_csi_grace_period and unneeded messages to be queued.
author aereaux <aidan@jmad.org>
date Sun, 22 Sep 2024 08:13:09 -0700
parent 5422:72f23107beb4
line wrap: on
line source

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      *See source code*   A list of reserved usernames
  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)
  block_registrations_require    `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_require = "^[a-zA-Z0-9_.-]+$" -- Allow only simple ASCII characters in usernames

Compatibility
=============

  ------ -------
  0.12    Works
  0.11    Work
  ------ -------