annotate mod_muc_log.wiki @ 89:df513425de29

muc_log is now a global module!
author t.ephraim
date Mon, 09 Nov 2009 22:52:27 +0000
parents 5ba104fb183e
children dc4125a5f438
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
1 #summary Module which logs muc conversations to a file
71
87bba9ac5896 removed folder config option. isn't needed anymore, cause we use datamanager to store the logging stuff.
t.ephraim
parents: 70
diff changeset
2 #labels Stage-Beta
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
3
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
4 = Introduction =
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
5
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
6 This module logs the conversation of muc running on this server to a daily changing file.
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
7 There is a file per room.
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
8
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
9 = Details =
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
10
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
11 Here is a example config with just the muclogging parts added to the right sections:
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12 {{{
89
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
13 Host "*"
63
c05ce0ae01e2 Edited wiki page through web user interface.
t.ephraim
parents: 62
diff changeset
14 modules_enabled = {
89
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
15 .....
63
c05ce0ae01e2 Edited wiki page through web user interface.
t.ephraim
parents: 62
diff changeset
16 "muc_log";
89
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
17 .....
63
c05ce0ae01e2 Edited wiki page through web user interface.
t.ephraim
parents: 62
diff changeset
18 }
c05ce0ae01e2 Edited wiki page through web user interface.
t.ephraim
parents: 62
diff changeset
19
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
20 muc_log = {
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
21 http_port = 5290;
88
5ba104fb183e added description for showJoin and showStatus
t.ephraim
parents: 87
diff changeset
22 showJoin = false; -- default is true
5ba104fb183e added description for showJoin and showStatus
t.ephraim
parents: 87
diff changeset
23 showStatus = false; -- default is true
89
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
24 }
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
25
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
26 component "rooms.example.com" "muc"
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
27 logging = true;
df513425de29 muc_log is now a global module!
t.ephraim
parents: 88
diff changeset
28
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
29 }}}
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
30
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
31 The http server part would then be reachable at the url:
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
32 {{{
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
33 http://example.com:5290/muc_log/
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
34 }}}
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
35
88
5ba104fb183e added description for showJoin and showStatus
t.ephraim
parents: 87
diff changeset
36 showJoin sets the default for showing joins or leaves.
5ba104fb183e added description for showJoin and showStatus
t.ephraim
parents: 87
diff changeset
37 showStatus sets the default for showing status changes.
5ba104fb183e added description for showJoin and showStatus
t.ephraim
parents: 87
diff changeset
38
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
39 = TODO =
73
3ff74599170f better wording
t.ephraim
parents: 71
diff changeset
40 * log/output bans correctly
86
d9d13329742a Updated todos
t.ephraim
parents: 73
diff changeset
41 * show a nice errormessage when lfs is not installed
87
3fe2370b1c85 TODOs updated
t.ephraim
parents: 86
diff changeset
42 * let the admin choose to enable logging via room config
64
1445b5e36674 added some todos, so I can remember them
t.ephraim
parents: 63
diff changeset
43 * testing testing