mod_muc_ping/README.markdown
author Kim Alvefur <zash@zash.se>
Tue, 09 Oct 2018 16:47:27 +0200
changeset 3360 31e113823463
parent 3353 35dc7c38e362
child 3385 861ddc74edd9
permissions -rw-r--r--
mod_muc_ping: Add more details to README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3353
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
This module implements the [Server
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
Optimization](https://xmpp.org/extensions/xep-0410.html#serveroptimization)
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
part of [XEP-0410: MUC Self-Ping]
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
3360
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
     5
# Usage
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
     6
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
     7
The module is loaded on MUC components:
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
     8
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
     9
```lua
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    10
Component "muc.example.com" "muc"
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    11
modules_enabled = {
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    12
    "muc_ping";
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    13
}
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    14
```
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    15
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    16
# Configuration
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    17
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    18
No options.
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    19
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    20
# Compatibility
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    21
3353
35dc7c38e362 mod_muc_ping: Implements the Server Optimization part of XEP-0410: MUC Self-Ping
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
It should work with Prosody up until 0.10.x.
3360
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    23
31e113823463 mod_muc_ping: Add more details to README
Kim Alvefur <zash@zash.se>
parents: 3353
diff changeset
    24
Prosody trunk natively supports XEP-0410 so this module is not needed.