mod_muc_auto_member/README.markdown
author Ben Smith <bens@effortlessis.com>
Tue, 14 May 2024 07:31:34 -0700
changeset 5912 dcea4b4c415d
parent 5166 243c156074d3
permissions -rw-r--r--
Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.

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