Mercurial > prosody-wiki
annotate mod_mam.wiki @ 451:171663daa144
mod_s2s_auth_fingerprint: remove info about pinning, this is the default now
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 27 Apr 2014 03:39:53 +0200 |
parents | b2ebc4473c4c |
children | 416ec6673229 |
rev | line source |
---|---|
296
fc11f3985d9b
It got published, and a number already
Kim Alvefur <zash@zash.se>
parents:
286
diff
changeset
|
1 #summary XEP-0313: Message Archive Management (Really) |
249 | 2 #labels Stage-Alpha |
3 | |
4 = Introduction = | |
5 | |
285
a1068d19ef5f
mod_mam: Update reference to the now published XEP
Kim Alvefur <zash@zash.se>
parents:
284
diff
changeset
|
6 Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]. Like [mod_archive] but much simpler. |
249 | 7 |
8 = Details = | |
9 | |
413 | 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. | |
249 | 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 {{{ | |
387 | 19 modules_enabled = { |
20 -- ... | |
21 "mam", | |
22 -- ... | |
23 } | |
24 storage = { | |
444
b2ebc4473c4c
mod_mam: Add note about storage config example
Kim Alvefur <zash@zash.se>
parents:
413
diff
changeset
|
25 -- This makes mod_mam use the sql2 storage backend (others will use internal) |
387 | 26 archive2 = "sql2"; |
27 } | |
249 | 28 }}} |
29 | |
30 = Configuration = | |
31 | |
413 | 32 The MAM protocol includes a method of changing preferecens regarding what |
33 messages should be stored. This allows users to enable or disable | |
34 archiving by default, and set rules for specific contacts. This module | |
35 will log no messages by default, for privacy concerns. If you decide to | |
36 change this, you should inform your users. | |
37 | |
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
38 {{{ |
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
39 default_archive_policy = true or false or "roster"; |
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
40 }}} |
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
41 |
413 | 42 This controls what messages are archived if the user hasn't set a |
43 matching rule, or another personal default. | |
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
44 |
413 | 45 * `false` means to store no messages. This is the default. |
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
46 * `"roster"` means to store messages to/from contacts in the users roster. |
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
47 * `true` means is to store all messages. |
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
48 |
284
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
49 {{{ |
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
50 max_archive_query_results = 50; |
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
51 }}} |
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
52 |
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
53 This is the largest number of messages that are allowed to be retrieved in one request. |
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
54 |
249 | 55 = Compatibility = |
260
ca66f14190ac
Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents:
259
diff
changeset
|
56 || trunk || Works || |
413 | 57 || 0.10 || Works || |
387 | 58 || 0.9 || Does not work || |
59 || 0.8 || Does not work || |