annotate mod_mam_muc.wiki @ 494:fb9e558dd1df

add page
author Kim Alvefur <zash@zash.se>
date Tue, 18 Nov 2014 14:03:41 +0100
parents 278feae4f92e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
493
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary XEP-0313: Message Archive Management for MUC
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 #labels Stage-Alpha
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 = Introduction =
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 This module logs the conversation of chatrooms running on the server to Prosody's archive storage.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 To access them you will need a client with support for
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 or a module such as [mod_http_muc_log].
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 = Usage =
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 First copy the module to the prosody plugins directory.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 Then add "mam_muc" to your modules_enabled list:
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 {{{
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 Component "conference.example.org" "muc"
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 modules_enabled = {
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 "mam_muc",
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 }
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 storage = {
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 -- This makes mod_mam_muc use the sql2 storage backend (others will use internal)
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 -- which at the time of this writing is the only one supporting stanza archives
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 muc_log = "sql2";
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 }
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 }}}
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 See [https://prosody.im/doc/storage Prosodys data storage documentation]
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 for more info on how to configure storage for different plugins.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 = Configuration =
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 Logging needs to be enabled for each room in the room configuration dialog.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 {{{
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 muc_log_all_rooms = false; -- set to true to force logging of all rooms
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 -- This is the largest number of messages that are allowed to be retrieved in one MAM request.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 max_archive_query_results = 20;
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 -- This is the largest number of messages that are allowed to be retrieved when joining a room.
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 max_history_messages = 1000;
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 }}}
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 = Compatibility =
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 || trunk || Works ||
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 || 0.10 || Works ||
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 || 0.9 || Does not work ||
278feae4f92e add page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 || 0.8 || Does not work ||