Mercurial > prosody-modules

comparison mod_mam_muc/README.markdown @ 1803:4d73a1a6ba68

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