Mercurial > prosody-wiki
annotate mod_mam.wiki @ 502:3c81d8a9f1e2
Documentation for the new mod_admin_message module.
| author | mikael.berthe@gmail.com |
|---|---|
| date | Sun, 25 Jan 2015 19:07:33 +0000 |
| parents | cd074071ac43 |
| children |
| rev | line source |
|---|---|
| 501 | 1 #summary XEP-0313: Message Archive Management |
| 2 #labels Stage-Beta | |
| 249 | 3 |
| 4 = Introduction = | |
| 5 | |
| 501 | 6 Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]. |
| 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) |
| 501 | 26 -- which at the time of this writing is the only one supporting stanza archives |
| 387 | 27 archive2 = "sql2"; |
| 28 } | |
| 249 | 29 }}} |
| 30 | |
| 452 | 31 See [https://prosody.im/doc/storage Prosodys data storage documentation] |
| 32 for more info on how to configure storage for different plugins. | |
| 33 | |
| 249 | 34 = Configuration = |
| 35 | |
| 485 | 36 The MAM protocol includes a method of changing preferences regarding what |
| 413 | 37 messages should be stored. This allows users to enable or disable |
| 452 | 38 archiving by default, and set rules for specific contacts. This module |
| 39 will log no messages by default, for privacy concerns. If you decide to | |
| 413 | 40 change this, you should inform your users. |
| 41 | |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
42 {{{ |
| 452 | 43 default_archive_policy = false -- other options are true or "roster"; |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
44 }}} |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
45 |
| 413 | 46 This controls what messages are archived if the user hasn't set a |
| 47 matching rule, or another personal default. | |
|
259
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
48 |
| 413 | 49 * `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
|
50 * `"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
|
51 * `true` means is to store all messages. |
|
6fb8d4252b73
Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents:
251
diff
changeset
|
52 |
|
284
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
53 {{{ |
| 452 | 54 max_archive_query_results = 20; |
|
284
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
55 }}} |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
56 |
|
0558c44908fe
mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents:
260
diff
changeset
|
57 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
|
58 |
| 249 | 59 = Compatibility = |
|
260
ca66f14190ac
Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents:
259
diff
changeset
|
60 || trunk || Works || |
| 413 | 61 || 0.10 || Works || |
| 387 | 62 || 0.9 || Does not work || |
| 501 | 63 || 0.8 || Does not work || |