File

mod_muc_auto_member/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 5162:243c156074d3
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.