changeset 114:0abc8d412aad

Clarified documentation, configuration, etc.
author MWild1
date Mon, 01 Feb 2010 17:36:46 +0000
parents 49ec592e43f6
children 03ee54266b45
files mod_muc_log_http.wiki
diffstat 1 files changed, 14 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/mod_muc_log_http.wiki	Mon Feb 01 17:29:52 2010 +0000
+++ b/mod_muc_log_http.wiki	Mon Feb 01 17:36:46 2010 +0000
@@ -1,15 +1,18 @@
-#summary module which acts as a website to show mod_muc_log saved loggings.
+#summary Provides a web interface to stored chatroom logs
+#labels Stage-Beta
 
 = Introduction =
 
-This module will give you the option to show the logged muc conversations in a simple website.
+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.
+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 Host "`*`" section.
+
 {{{
 Host "*"
    modules_enabled = {
@@ -25,17 +28,18 @@
        theme = "default"; -- default is theme "default"
    }
 }}}
-showJoin sets the default for showing joins or leaves.
-showStatus sets the default for showing status changes.
 
-The http server part would then be reachable at the url:
+*showJoin* sets the default for showing joins or leaves.
+*showStatus* sets the default for showing status changes.
+
+The web interface would then be reachable at the address:
 {{{
 http://example.com:5290/muc_log/
 }}}
 
 
 = TODO =
-  * log/output bans correctly
-  * let the admin choose to enable logging via room config
-  * quota ~ per day ?!
-  * testing testing
\ No newline at end of file
+  * Log bans correctly
+  * Let the admin choose to enable logging via room config
+  * Quota ~ per day ?!
+  * Testing testing :)
\ No newline at end of file