annotate mod_muc_log_http.wiki @ 111:291ee152eea9

added a short install description and a note about the default port.
author t.ephraim
date Mon, 01 Feb 2010 16:22:39 +0000
parents dfbbf18655db
children 0abc8d412aad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
1 #summary module which acts as a website to show mod_muc_log saved loggings.
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
2
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
3 = Introduction =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
4
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
5 This module will give you the option to show the logged muc conversations in a simple website.
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
6
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
7 = Installation =
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
8
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
9 Just copy the folder muc_log_http as it is, into the modules folder of your prosody.
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
10
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
11 = Configuration Details =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
13 {{{
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
14 Host "*"
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
15 modules_enabled = {
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 "muc_log_http";
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 }
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 muc_log_http = {
111
291ee152eea9 added a short install description and a note about the default port.
t.ephraim
parents: 101
diff changeset
22 http_port = 5290; -- default is 5290
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
23 showJoin = false; -- default is true
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
24 showStatus = false; -- default is true
101
dfbbf18655db Added theme configure option
t.ephraim
parents: 100
diff changeset
25 theme = "default"; -- default is theme "default"
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
26 }
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
27 }}}
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
28 showJoin sets the default for showing joins or leaves.
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
29 showStatus sets the default for showing status changes.
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 The http server part would then be reachable at the url:
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
32 {{{
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
33 http://example.com:5290/muc_log/
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
34 }}}
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
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
37 = TODO =
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
38 * log/output bans correctly
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
39 * let the admin choose to enable logging via room config
100
6eb99327f14a Updated TODOs
t.ephraim
parents: 95
diff changeset
40 * quota ~ per day ?!
95
f18d4607c52d Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
41 * testing testing