Mercurial > prosody-modules

comparison mod_mam_muc/README.wiki @ 1782:29f3d6b7ad16

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