diff mod_muc_log_http/README.wiki @ 1782:29f3d6b7ad16

Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_log_http/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,46 @@
+#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_muc_log].
+
+= Installation =
+
+Just copy the folder muc_log_http as it is, into the modules folder of your Prosody installation.
+
+= Configuration Details =
+
+Example configuration:
+
+{{{
+	Component "conference.example.com" "muc"
+	modules_enabled = {
+		.....
+		"muc_log";
+		"muc_log_http";
+		.....
+	}
+
+	muc_log_http = { -- These are the defaults
+		show_join = true;
+		show_presences = true;
+		show_status = true;
+		theme = "prosody";
+		url_base = "muc_log";
+	}
+}}}
+
+*show_join* sets the default for showing joins or leaves.
+*show_status* sets the default for showing status changes.
+
+The web interface would then be reachable at the address:
+{{{
+http://conference.example.com:5280/muc_log/
+}}}
+
+
+= TODO =
+  * Log bans correctly
+  * Quota ~ per day ?!
+  * Testing testing :)