Mercurial > prosody-wiki
annotate mod_mam.wiki @ 286:27d80566611b
mod_mam: Re-write the Details section to be more accurate with current behaviour
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 09 Jun 2012 00:03:02 +0200 |
| parents | a1068d19ef5f |
| children | fc11f3985d9b |
| rev | line source |
|---|---|
| 249 | 1 #summary XEP-xxxx: Message Archive Management (Really) |
| 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 | |
|
286
27d80566611b
mod_mam: Re-write the Details section to be more accurate with current behaviour
Kim Alvefur <zash@zash.se>
parents:
285
diff
changeset
|
10 This module will archive all messages that match the simple rules setup by the user, and allow the user to access this archive. |
| 249 | 11 |
| 12 = Usage = | |
| 13 | |
| 14 First copy the module to the prosody plugins directory. | |
| 15 | |
| 16 Then add "mam" to your modules_enabled list: | |
| 17 {{{ | |
| 18 modules_enabled = { | |
| 19 -- ... | |
| 20 "mam", | |
| 21 -- ... | |
| 22 } | |
| 23 }}} | |
| 24 | |
| 25 = Configuration = | |
| 26 | |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
27 {{{ |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
28 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
|
29 }}} |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
30 |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
31 This controls what messages are archived if the user hasn't set a matching rule, or another personal default. |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
32 |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
33 * `false` means to store no messages. This is the built in default. |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
34 * `"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
|
35 * `true` means is to store all messages. |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
36 |
|
284
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
37 {{{ |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
38 max_archive_query_results = 50; |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
39 }}} |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
40 |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
41 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
|
42 |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
43 |
| 249 | 44 = Compatibility = |
|
260
ca66f14190ac
Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents:
259
diff
changeset
|
45 || 0.8 || Works || |
|
ca66f14190ac
Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents:
259
diff
changeset
|
46 || 0.9 || Works || |
|
ca66f14190ac
Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents:
259
diff
changeset
|
47 || trunk || Works || |
| 249 | 48 |
| 49 = TODO = | |
| 50 | |
| 251 | 51 * Optimize |
| 52 * Use new stanza archive API once it appears | |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
53 * Policy enforcing. |