PapaTutuWawa/prosody-modules
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

mod_mix: Update README

Browse Source
This commit is contained in:
PapaTutuWawa 2021-06-02 17:18:29 +02:00
parent b7b477b0bd
commit 7d90d14fe5
1 changed files with 38 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
mod_mix/README.markdown
View File

@ -1,26 +1,46 @@
This module enables prosody to use Mediated Information Exchange with ---
the following protocols being supported: labels:
- 'Stage-Alpha'
summary: 'XEP-0369: Mediated Information eXchange (MIX)'
...
- MIX-CORE Introduction
- MIX-ADMIN ============
Note that this module does not provice MIX-PAM, which is need for MIX clients to function. This module implements [XEP-0369: Mediated Information eXchange (MIX)](https://xmpp.org/extensions/xep-0369.html).
| Option | Description | Default | Configuration
| --- | --- | --- | =============
| `default_description` | The default description of a newly created channel | `""` |
| `default_name` | The default name of a newly created channel | `"MIX Channel"` |
| `service_name` | The name of the MIX service during service discovery | `"Prosody MIX Service"` |
| `restrict_channel_creation` | Controls who can create channels | `"local"` |
`restrict_channel_creation` has two modes of operation: ```
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` - `"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 - `{ ... }`: If the value is a table, then one can list hosts or users that are allowed to create channels
## Example configuration Compatibility
```lua =============
Component "mix.example.org" "mix"
service_name = "My name Jeff" ----- --------
restrict_channel_creation = { "exmaple_org" } trunk Untested
``` 0.11 Works
----- --------