view mod_muc_local_only/README.markdown @ 5174:354832098f2f

mod_muc_rtbl: move use of "private" attributes to single function This way, we reduce the scope where you can have a typo in the attribute name to that function and we encourage users to actually always call update_hashes.
author Jonas Schäfer <jonas@wielicki.name>
date Tue, 21 Feb 2023 21:41:19 +0100
parents 221b6bee26e2
children
line wrap: on
line source

# Introduction

This module allows you to make one or more MUCs as accessible to local users only.

# Details

Local users (anyone on the same server as the MUC) are granted automatic
membership when they first join the room. Users from other servers are
denied access (even if the room is otherwise configured to be open).

# Configuring

## Enabling

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

## Settings

Specify a list of MUCs in your config like so:

```
muc_local_only = { "my-local-chat@conference.example.com" }
```

# Compatibility

Requires Prosody 0.11.0 or later.

# Future

It would be good to add a room configuration option.