mod_component_client/README.markdown
author Ben Smith <bens@effortlessis.com>
Tue, 14 May 2024 07:31:34 -0700
changeset 5912 dcea4b4c415d
parent 2327 35ae59a8196d
permissions -rw-r--r--
Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.
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
```