Mercurial > prosody-modules
view mod_block_registrations/README.markdown @ 5010:a1f49586d28a
mod_restrict_xmpp: Treat archive query as a read despite using iq-set
XEP-0313 uses iq-set to initiate a query, but unlike many other uses of
iq-set, this does not mutate anything on the server, so it should not be
treated as a write request.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 22 Aug 2022 23:51:07 +0200 |
| parents | 9b43b7fc3558 |
| children | 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 ----- -------------