Software /
code /
prosody-modules
File
mod_block_registrations/README.markdown @ 5421:a58ba20b3a71
mod_block_registrations: Update description expansion of default list
The default got a lot longer in 368bf9b06484, a bit too long to fit
comfortably in this table.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 06 May 2023 17:04:28 +0200 |
parent | 2715:9b43b7fc3558 |
child | 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.9 Works 0.8 Should work ----- -------------