Mercurial > prosody-wiki

annotate mod_muc_log_http.wiki @ 157:84cd497e50ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typos, some better wording
author florob@babelmonkeys.de
date Sat, 16 Oct 2010 19:04:27 +0000
parents 2b79ecd3ece6
children 646476e373af
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
1 #summary Provides a web interface to stored chatroom logs
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
2 #labels Stage-Beta
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
3
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
4 = Introduction =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
5
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
6 This module provides a built-in web interface to view chatroom logs stored by [mod_muc_log].
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
7
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
8 = Installation =
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
9
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
10 Just copy the folder muc_log_http as it is, into the modules folder of your Prosody installation.
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
11
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12 = Configuration Details =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
13
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
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.
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
15
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
16 {{{
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
17 Host "*"
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
18 modules_enabled = {
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
19 .....
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
20 "muc_log_http";
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
21 .....
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
22 }
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
23
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
24 muc_log_http = {
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
25 http_port = 5290; -- default is 5290
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
26 showJoin = false; -- default is true
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
27 showStatus = false; -- default is true
135
2b79ecd3ece6 Edited wiki page through web user interface.
t.ephraim
parents: 114
diff changeset
28 theme = "prosody"; -- default is theme "prosody"
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
29 }
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
30 }}}
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
31
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
32 *showJoin* sets the default for showing joins or leaves.
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
33 *showStatus* sets the default for showing status changes.
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
34
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
35 The web interface would then be reachable at the address:
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
36 {{{
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
37 http://example.com:5290/muc_log/
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
38 }}}
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
39
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
40
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
41 = TODO =
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
42 * Log bans correctly
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
43 * Let the admin choose to enable logging via room config
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
44 * Quota ~ per day ?!
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
45 * Testing testing :)