|
1782
|
1 #summary XEP-0313: Message Archive Management |
|
|
2 #labels Stage-Beta |
|
|
3 |
|
|
4 = Introduction = |
|
|
5 |
|
|
6 Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]. |
|
|
7 |
|
|
8 = Details = |
|
|
9 |
|
|
10 This module will archive all messages that match the simple rules setup by the |
|
|
11 user, and allow the user to access this archive. |
|
|
12 |
|
|
13 = Usage = |
|
|
14 |
|
|
15 First copy the module to the prosody plugins directory. |
|
|
16 |
|
|
17 Then add "mam" to your modules_enabled list: |
|
|
18 {{{ |
|
|
19 modules_enabled = { |
|
|
20 -- ... |
|
|
21 "mam", |
|
|
22 -- ... |
|
|
23 } |
|
|
24 }}} |
|
|
25 |
|
|
26 = Storage backend = |
|
|
27 |
|
|
28 mod_mam uses the store "archive2". |
|
|
29 See [https://prosody.im/doc/storage Prosodys data storage documentation] |
|
|
30 for information on how to configure storage. |
|
|
31 |
|
|
32 = Configuration = |
|
|
33 |
|
|
34 The MAM protocol includes a method of changing preferences regarding what |
|
|
35 messages should be stored. This allows users to enable or disable |
|
|
36 archiving by default, and set rules for specific contacts. This module |
|
|
37 will log no messages by default, for privacy concerns. If you decide to |
|
|
38 change this, you should inform your users. |
|
|
39 |
|
|
40 {{{ |
|
|
41 default_archive_policy = false -- other options are true or "roster"; |
|
|
42 }}} |
|
|
43 |
|
|
44 This controls what messages are archived if the user hasn't set a |
|
|
45 matching rule, or another personal default. |
|
|
46 |
|
|
47 * `false` means to store no messages. This is the default. |
|
|
48 * `"roster"` means to store messages to/from contacts in the users roster. |
|
|
49 * `true` means is to store all messages. |
|
|
50 |
|
|
51 {{{ |
|
|
52 max_archive_query_results = 20; |
|
|
53 }}} |
|
|
54 |
|
|
55 This is the largest number of messages that are allowed to be retrieved in one request. |
|
|
56 |
|
|
57 = Compatibility = |
|
|
58 || trunk || Works || |
|
|
59 || 0.10 || Works, requires a storage driver with archive support, eg mod_storage_sql2 in 0.10 || |
|
|
60 || 0.9 || Unsupported || |
|
|
61 || 0.8 || Does not work || |
