annotate mod_muc_reserve_nick_pattern/README.md @ 6562:5da6fb562df9 default tip

mod_unified_push: Fix push error handling (fixes #2000) Use the error object that send_iq() passes as an argument to it's reject callback instead of attempting and failing to do the parsing in the callback itself.
author kmq
date Mon, 06 Jul 2026 14:23:57 +0200
parents d5b9da8c94ae
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5172
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
1 ---
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
2 labels:
6475
d5b9da8c94ae muc_reserve_nick_pattern and muc_restrict_nick: beta status and mention each other.
Menel <menel@snikket.de>
parents: 5975
diff changeset
3 - 'Stage-Beta'
d5b9da8c94ae muc_reserve_nick_pattern and muc_restrict_nick: beta status and mention each other.
Menel <menel@snikket.de>
parents: 5975
diff changeset
4 summary: 'Require MUC occupant nicknames to not match some patterns'
5172
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
5 ---
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
6
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
7 Introduction
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
8 ============
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
9
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
10 This checks the nickname of a joining user against a configurable list of
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
11 [Lua patterns](https://www.lua.org/manual/5.2/manual.html#6.4.1), and prevents
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
12 them from joining if it matches any of them.
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
13
6475
d5b9da8c94ae muc_reserve_nick_pattern and muc_restrict_nick: beta status and mention each other.
Menel <menel@snikket.de>
parents: 5975
diff changeset
14 Note the similar module: [mod_muc_restrict_nick]
d5b9da8c94ae muc_reserve_nick_pattern and muc_restrict_nick: beta status and mention each other.
Menel <menel@snikket.de>
parents: 5975
diff changeset
15
5172
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
16 Configuration
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
17 =============
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
18
6475
d5b9da8c94ae muc_reserve_nick_pattern and muc_restrict_nick: beta status and mention each other.
Menel <menel@snikket.de>
parents: 5975
diff changeset
19 Load it under a muc component.
5172
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
20 There is a single configuration option, `muc_reserve_nick_patterns` and the
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
21 default is `{}` - i.e. allow everything.
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
22
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
23 Compatibility
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
24 =============
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
25
dc6a10629670 New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff changeset
26 Requires Prosody 0.11 or higher.