diff mod_http_muc_log.wiki @ 492:800a801a5f71

add page
author Kim Alvefur <zash@zash.se>
date Tue, 18 Nov 2014 14:03:24 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_muc_log.wiki	Tue Nov 18 14:03:24 2014 +0100
@@ -0,0 +1,38 @@
+#summary Provides a web interface to stored chatroom logs
+#labels Stage-Beta
+
+= Introduction =
+
+This module provides a built-in web interface to view chatroom logs stored by [mod_mam_muc].
+
+= 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 [http://prosody.im/doc/http the page about Prosodys HTTP server] for info about the address.
+
+= Compatibility =
+
+Requires Prosody 0.10 or above and a storage backend with support for stanza archives.