mod_muc_local_only/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 13 Nov 2023 12:02:54 +0100
changeset 5710 655f90b149a4
parent 4023 221b6bee26e2
permissions -rw-r--r--
mod_audit: Pass IP address in string form Passing an util.ip object to :text_tag() would be an error.

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