changeset 2323:35ae59a8196d

Add some documentation stubs
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 20:34:43 +0200
parents 73fbfd1e820b
children 1424aa8877f0
files mod_component_client/README.markdown mod_listusers/README.markdown mod_log_messages_sql/README.markdown mod_measure_storage/README.markdown
diffstat 4 files changed, 67 insertions(+), 0 deletions(-) [+]
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";
+}
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_listusers/README.markdown	Sat Oct 01 20:34:43 2016 +0200
@@ -0,0 +1,5 @@
+This module adds a command to `prosodyctl` for listing users.
+
+``` sh
+prosodyctl mod_listusers
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_log_messages_sql/README.markdown	Sat Oct 01 20:34:43 2016 +0200
@@ -0,0 +1,19 @@
+This module logs messages to a SQL database.
+
+SQL connection options are configured in a `message_log_sql` option,
+which has the same syntax as the `sql` option for
+[mod_storage_sql][doc:modules:mod_storage_sql].
+
+You will need to create the following table in the configured database:
+
+``` sql
+CREATE TABLE `prosodyarchive` (
+        `host` TEXT,
+        `user` TEXT,
+        `store` TEXT,
+        `id` INTEGER PRIMARY KEY AUTOINCREMENT,
+        `when` INTEGER,
+        `with` TEXT,
+        `resource` TEXT,
+        `stanza` TEXT);
+```
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_measure_storage/README.markdown	Sat Oct 01 20:34:43 2016 +0200
@@ -0,0 +1,24 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Measure storage API operations
+---
+
+Introduction
+============
+
+This module collects statistics from storage operations.
+
+Configuration
+=============
+
+Enable tagged metrics, whatever that is:
+
+``` {.lua}
+measure_storage_tagged_metric = true
+```
+
+Compatibility
+=============
+
+Requires 0.10