Mercurial > prosody-modules

view mod_muc_restrict_nick/README.markdown @ 5138:4511e90d1d08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_unified_push: README: Documentation updates (example, etc.)
author Matthew Wild <mwild1@gmail.com>
date Tue, 10 Jan 2023 16:07:00 +0000
parents e7b126161e7b
children
line wrap: on
line source

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