Software /
code /
prosody-modules
Annotate
mod_muc_restrict_nick/README.markdown @ 4966:4ffd6551f4bb
mod_firewall: README: Clarify when storage access can occur with roster checks
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Tue, 28 Jun 2022 16:39:44 +0100 |
parent | 4588:e7b126161e7b |
rev | line source |
---|---|
4588
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 labels: |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 - 'Stage-Alpha' |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 summary: 'Require MUC occupant nicknames to match a specific pattern' |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 --- |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 Introduction |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 ============ |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 This checks the nickname of a joining user against a configurable |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 [Lua pattern](https://www.lua.org/manual/5.2/manual.html#6.4.1), and prevents |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 them from joining if it does not match. |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 Configuration |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 ============= |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 There is a single configuration option, `muc_restrict_nick_pattern` and the |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 default is `"^%w+$"` - i.e. allow only alphanumeric characters in nicknames. |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 Compatibility |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 ============= |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 |
e7b126161e7b
mod_muc_restrict_nick: New module to restrict MUC occupant nicknames
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 Requires Prosody 0.11 or higher. |