diff mod_component_client/README.markdown @ 2323:35ae59a8196d

Add some documentation stubs
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 20:34:43 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_component_client/README.markdown	Sat Oct 01 20:34:43 2016 +0200
@@ -0,0 +1,19 @@
+Introduction
+============
+
+This module turns Prosody hosts into components of other XMPP servers.
+
+Configuration
+=============
+
+Example configuration:
+
+``` {.lua}
+VirtualHost "component.example.com"
+modules_enabled = { "component_client" }
+component_client = {
+    host = "localhost";
+    port = 5347;
+    secret = "hunter2";
+}
+```