view mod_muc_restrict_attention/README.md @ 6446:63ce1af4d099

mod_muc_restrict_attention: adjusted more variable names to reflect it works on members
author Menel <menel@snikket.de>
date Wed, 11 Mar 2026 08:55:15 +0100
parents 1932fd38d353
children 3d14a407307d
line wrap: on
line source

---
summary: Strip XEP-0224 Attention from unaffiliated users in rooms
labels:
- Stage-Beta
...

# Introduction

This module strips [XEP-0224 Attention] for certain affiliations in rooms.
It adds a room configuration option to strip it from members, so that only admins and higher can use it.
A default setting for all rooms can be set in the config file. This can be overwritten per room.
With this module loaded, unaffiliated users won't ever be allowed to use *Attention*.

This can prevent spam and noise in clients that don't have precautions against this in place.

# Configuring

## Enabling

``` {.lua}
Component "rooms.example.net" "muc"
modules_enabled = {
    "muc_restrict_attention";
}
```

## Settings

A default setting can be provided in the config file, defaults to *true*.
A loglevel can be set (debug, info, warn, error).
Defaults to *debug*: 

``` {.lua}
muc_restrict_attention_from_members = true
muc_restrict_attention_loglevel = "debug"
```

# Todo

- Restrict fine tuned, per every affiliation.

# Compatibility

Work with Prosody >= 13.0