Software /
code /
prosody-modules
File
mod_block_registrations/README.markdown @ 4975:733e5513f691
various: Use 0.12+ API for serving files from the file system over HTTP
Using mod_http_files this way is deprecated. Having the base behavior in
a separate module makes it easier to have a specialized module with
coherent behavior that does not do things when not explicitly enabled.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 18 Jul 2022 13:58:27 +0200 |
parent | 2715:9b43b7fc3558 |
child | 5421:a58ba20b3a71 |
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 `{ "admin" }` 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 ----- -------------