comparison mod_muc_log_http.wiki @ 114:0abc8d412aad

Clarified documentation, configuration, etc.
author MWild1
date Mon, 01 Feb 2010 17:36:46 +0000
parents 291ee152eea9
children 2b79ecd3ece6
comparison
equal deleted inserted replaced
113:49ec592e43f6 114:0abc8d412aad
1 #summary module which acts as a website to show mod_muc_log saved loggings. 1 #summary Provides a web interface to stored chatroom logs
2 #labels Stage-Beta
2 3
3 = Introduction = 4 = Introduction =
4 5
5 This module will give you the option to show the logged muc conversations in a simple website. 6 This module provides a built-in web interface to view chatroom logs stored by [mod_muc_log].
6 7
7 = Installation = 8 = Installation =
8 9
9 Just copy the folder muc_log_http as it is, into the modules folder of your prosody. 10 Just copy the folder muc_log_http as it is, into the modules folder of your Prosody installation.
10 11
11 = Configuration Details = 12 = Configuration Details =
13
14 You need to add muc_log_http to your global modules_enabled, and the configuration options similarly must be put into your Host "`*`" section.
12 15
13 {{{ 16 {{{
14 Host "*" 17 Host "*"
15 modules_enabled = { 18 modules_enabled = {
16 ..... 19 .....
23 showJoin = false; -- default is true 26 showJoin = false; -- default is true
24 showStatus = false; -- default is true 27 showStatus = false; -- default is true
25 theme = "default"; -- default is theme "default" 28 theme = "default"; -- default is theme "default"
26 } 29 }
27 }}} 30 }}}
28 showJoin sets the default for showing joins or leaves.
29 showStatus sets the default for showing status changes.
30 31
31 The http server part would then be reachable at the url: 32 *showJoin* sets the default for showing joins or leaves.
33 *showStatus* sets the default for showing status changes.
34
35 The web interface would then be reachable at the address:
32 {{{ 36 {{{
33 http://example.com:5290/muc_log/ 37 http://example.com:5290/muc_log/
34 }}} 38 }}}
35 39
36 40
37 = TODO = 41 = TODO =
38 * log/output bans correctly 42 * Log bans correctly
39 * let the admin choose to enable logging via room config 43 * Let the admin choose to enable logging via room config
40 * quota ~ per day ?! 44 * Quota ~ per day ?!
41 * testing testing 45 * Testing testing :)