prosody-modules/mod_mix/README.markdown

47 lines
1.1 KiB
Markdown

---
labels:
- 'Stage-Alpha'
summary: 'XEP-0369: Mediated Information eXchange (MIX)'
...
Introduction
============
This module implements [XEP-0369: Mediated Information eXchange (MIX)](https://xmpp.org/extensions/xep-0369.html).
Configuration
=============
```
VirtualHost "example.org"
-- [...]
disco_items = {
-- [...]
{ "mix.example.org", "My cool mix service" };
-- [...]
}
-- [...]
Component "mix.example.org" "mix"
service_name = "My cool mix service"
restrict_channel_creation = { "example.org" }
default_name = "Awesome new channel"
default_description = "A cool new channel that someone made"
```
`restrict_channel_creation` controls who can create channels on this MIX host
and has two modes of operation:
- `"local"`: Only local users can create channels, e.g. `romeo@example.org` can create channels on `mix.example.org`, but not `juliet@example.net`
- `{ ... }`: If the value is a table, then one can list hosts or users that are allowed to create channels
Compatibility
=============
----- --------
trunk Untested
0.11 Works
----- --------