view mod_muc_local_only/README.markdown @ 4441:58a112bd9792

mod_s2s_auth_posh: Use unused loop variable for something [luacheck] Saves a function call, shuts up luacheck. In no case does the input list of certificates not result in a list of fingerprints of equal length.
author Kim Alvefur <zash@zash.se>
date Thu, 11 Feb 2021 15:51:27 +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.