mod_muc_restrict_nick/README.markdown
author Stephen Paul Weber <singpolyma@singpolyma.net>
Sun, 25 Feb 2024 19:10:30 -0500
changeset 5849 83ee752f148c
parent 4592 e7b126161e7b
permissions -rw-r--r--
mod_push2: empty table instead of nil when not present

---
labels:
- 'Stage-Alpha'
summary: 'Require MUC occupant nicknames to match a specific pattern'
---

Introduction
============

This checks the nickname of a joining user against a configurable
[Lua pattern](https://www.lua.org/manual/5.2/manual.html#6.4.1), and prevents
them from joining if it does not match.

Configuration
=============

There is a single configuration option, `muc_restrict_nick_pattern` and the
default is `"^%w+$"` - i.e. allow only alphanumeric characters in nicknames.

Compatibility
=============

Requires Prosody 0.11 or higher.