diff mod_http_muc_log/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_http_muc_log/README.wiki@29f3d6b7ad16
children 79b9bd84b91c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_muc_log/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,48 @@
+---
+labels:
+- 'Stage-Beta'
+summary: Provides a web interface to stored chatroom logs
+...
+
+Introduction
+============
+
+This module provides a built-in web interface to view chatroom logs
+stored by [mod\_mam\_muc](mod_mam_muc.md).
+
+Installation
+============
+
+Just copy the folder muc\_log\_http as it is, into the modules folder of
+your Prosody installation.
+
+Configuration Details
+=====================
+
+You need to add muc\_log\_http to your global modules\_enabled, and the
+configuration options similarly must be put into your global
+(server-wide) options section:
+
+        Component "conference.example.com" "muc"
+        modules_enabled = {
+            .....
+            "mam_muc";
+            "http_muc_log";
+            .....
+        }
+        storage = {
+            muc_log = "sql2"; -- for example
+        }
+
+The web interface would then be reachable at the address:
+
+    http://conference.example.com:5280/muc_log/
+
+See [the page about Prosodys HTTP server](http://prosody.im/doc/http)
+for info about the address.
+
+Compatibility
+=============
+
+Requires Prosody 0.10 or above and a storage backend with support for
+stanza archives.