mod_component_client/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 09:25:46 +0100
changeset 5062 39c2824c2880
parent 2327 35ae59a8196d
permissions -rw-r--r--
mod_cloud_notify: README overhaul
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2327
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
Introduction
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
============
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
This module turns Prosody hosts into components of other XMPP servers.
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
Configuration
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
=============
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
Example configuration:
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
``` {.lua}
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
VirtualHost "component.example.com"
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
modules_enabled = { "component_client" }
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
component_client = {
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
    host = "localhost";
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
    port = 5347;
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
    secret = "hunter2";
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
}
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
```