mod_muc_restrict_nick/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 08:06:11 +0100
changeset 5060 2583bd7eb5d1
parent 4592 e7b126161e7b
permissions -rw-r--r--
mod_cloud_notify: Add warnings about options including real body/sender

---
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.