Mercurial > prosody-modules
annotate mod_muc_reserve_nick_pattern/README.markdown @ 5709:0c9606770db1
mod_audit: Also record human-readable name of country
Nicer to show in graphs but less machine-usable
Throw in continent in case that turns out to be useful one day
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 13 Nov 2023 12:22:17 +0100 |
parents | dc6a10629670 |
children |
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: |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
3 - 'Stage-Alpha' |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
4 summary: 'Require MUC occupant nicknames to no match some patterns' |
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 |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
14 Configuration |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
15 ============= |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
16 |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
17 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
|
18 default is `{}` - i.e. allow everything. |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
19 |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
20 Compatibility |
dc6a10629670
New module, mod_muc_reserve_nick_pattern
Stephen Paul Weber <singpolyma@singpolyma.net>
parents:
diff
changeset
|
21 ============= |
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 Requires Prosody 0.11 or higher. |