prosody-modules/mod_mix/README.markdown

47 lines
1.1 KiB
Markdown
Raw Normal View History

2021-06-02 15:18:29 +00:00
---
labels:
- 'Stage-Alpha'
summary: 'XEP-0369: Mediated Information eXchange (MIX)'
...
2021-02-28 10:44:36 +00:00
2021-06-02 15:18:29 +00:00
Introduction
============
2021-02-28 10:44:36 +00:00
2021-06-02 15:18:29 +00:00
This module implements [XEP-0369: Mediated Information eXchange (MIX)](https://xmpp.org/extensions/xep-0369.html).
2021-02-28 10:44:36 +00:00
2021-06-02 15:18:29 +00:00
Configuration
=============
2021-02-28 10:44:36 +00:00
2021-06-02 15:18:29 +00:00
```
VirtualHost "example.org"
-- [...]
2021-02-28 10:44:36 +00:00
2021-06-02 15:18:29 +00:00
disco_items = {
-- [...]
{ "mix.example.org", "My cool mix service" };
-- [...]
}
-- [...]
2021-02-28 10:44:36 +00:00
Component "mix.example.org" "mix"
2021-06-02 15:18:29 +00:00
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"
2021-02-28 10:44:36 +00:00
```
2021-06-02 15:18:29 +00:00
`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
----- --------