Mercurial > prosody-wiki

annotate mod_muc_log.wiki @ 491:e15448188d05

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update with current behaviour and options
author Kim Alvefur <zash@zash.se>
date Fri, 14 Nov 2014 17:41:54 +0100
parents 49ec592e43f6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
112
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
1 #summary Log chatroom messages to disk
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
113
49ec592e43f6 Fix link markup
MWild1
parents: 112
diff changeset
6 This module logs the conversation of chatrooms running on the server to Prosody's data store. To view them you will need a module such as [mod_muc_log_http].
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
7
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
8 = Details =
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
9
112
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
10 mod_muc_log must be loaded individually for the components that need it. Assuming you have a MUC component already running on conference.example.org then you can add muc_log to it like so:
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
11
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
12 {{{
112
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
13 Component "conference.example.org" "muc"
63
c05ce0ae01e2 Edited wiki page through web user interface.
t.ephraim
parents: 62
diff changeset
14 modules_enabled = {
94
82e7feef398c Edited wiki page through web user interface.
t.ephraim
parents: 92
diff changeset
15 "muc_log";
112
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
16 }
59
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
17 }}}
4410f015d570 Created wiki page through web user interface.
t.ephraim
parents:
diff changeset
18
491
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
19 Logging is not enabled by default. In 0.9+ logging can be enabled per room in the room config form.
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
20
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
21 To enable logging in older versions, or to enable logging by default for all rooms, set
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
22
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
23 {{{
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
24 muc_log_by_default = true -- Log all rooms by default
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
25 }}}
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
26
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
27
112
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
28 = Compatibility =
058ede538839 Clarified documentation, config and dependency on something else for viewing the logs.
MWild1
parents: 94
diff changeset
29 || 0.6 || Works ||
491
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
30 || 0.7 || Works ||
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
31 || 0.8 || Works ||
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
32 || 0.9 || Works ||
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
33
e15448188d05 Update with current behaviour and options
Kim Alvefur <zash@zash.se>
parents: 113
diff changeset
34 *Note* that per-room configuration only works in 0.9+.