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