Mercurial > prosody-wiki

annotate mod_muc_log_http.wiki @ 384:de32646965c3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix typo
author Kim Alvefur <zash@zash.se>
date Sun, 30 Jun 2013 20:20:26 +0200
parents 646476e373af
children 8b4e2a05f450
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
222
646476e373af Remove Host "*" references (thanks egon)
MWild1
parents: 135
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 global (server-wide) options section:
114
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 modules_enabled = {
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
18 .....
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
19 "muc_log_http";
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
20 .....
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 muc_log_http = {
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
24 http_port = 5290; -- default is 5290
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
25 showJoin = false; -- default is true
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
26 showStatus = false; -- default is true
135
2b79ecd3ece6 Edited wiki page through web user interface.
t.ephraim
parents: 114
diff changeset
27 theme = "prosody"; -- default is theme "prosody"
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
28 }
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
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
31 *showJoin* sets the default for showing joins or leaves.
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
32 *showStatus* sets the default for showing status changes.
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
33
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
34 The web interface would then be reachable at the address:
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
35 {{{
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
36 http://example.com:5290/muc_log/
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
37 }}}
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 = TODO =
114
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
41 * Log bans correctly
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
42 * Let the admin choose to enable logging via room config
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
43 * Quota ~ per day ?!
0abc8d412aad Clarified documentation, configuration, etc.
MWild1
parents: 111
diff changeset
44 * Testing testing :)