view mod_muc_auto_member/README.markdown @ 5734:cef8bce2d71b

luacheck: Add new module API methods from trunk See * trunk rev 4d4f9e42bcf8 * trunk rev 65fb0d7a2312 * trunk rev c9ef35fab0b1
author Kim Alvefur <zash@zash.se>
date Mon, 27 Nov 2023 07:10:06 +0100
parents 243c156074d3
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: "Automatically register new MUC participants as members"
...

# Introduction

This module automatically makes anybody who joins a MUC become a registered
member. This can be useful for certain use cases.

Note: there is no automatic cleanup of members. If you enable this on a server
with busy public channels, your member list will perpetually increase in size.

Also, there is currently no per-room option for this behaviour. That may be
added in the future, along with membership expiry.

# Configuration

There is currently no configuration for this module. The module should be
enabled on your MUC component, i.e. in the modules_enabled option under your
Component:

``` {.lua}
Component "conference.example.com" "muc"
    modules_enabled = {
        "muc_auto_member";
    }
```

# Compatibility

0.12 and later.