Mercurial > prosody-modules
annotate mod_mam/README.wiki @ 1801:5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 00:40:53 +0200 |
| parents | 29f3d6b7ad16 |
| children |
| rev | line source |
|---|---|
| 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 | |
|
1801
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
32 For example, to use mod_storage_sql2: |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
33 {{{ |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
34 storage = { |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
35 archive2 = "sql2"; |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
36 } |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
37 }}} |
|
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
38 |
| 1782 | 39 = Configuration = |
| 40 | |
| 41 The MAM protocol includes a method of changing preferences regarding what | |
| 42 messages should be stored. This allows users to enable or disable | |
| 43 archiving by default, and set rules for specific contacts. This module | |
| 44 will log no messages by default, for privacy concerns. If you decide to | |
| 45 change this, you should inform your users. | |
| 46 | |
| 47 {{{ | |
| 48 default_archive_policy = false -- other options are true or "roster"; | |
| 49 }}} | |
| 50 | |
| 51 This controls what messages are archived if the user hasn't set a | |
| 52 matching rule, or another personal default. | |
| 53 | |
| 54 * `false` means to store no messages. This is the default. | |
| 55 * `"roster"` means to store messages to/from contacts in the users roster. | |
| 56 * `true` means is to store all messages. | |
| 57 | |
| 58 {{{ | |
| 59 max_archive_query_results = 20; | |
| 60 }}} | |
| 61 | |
| 62 This is the largest number of messages that are allowed to be retrieved in one request. | |
| 63 | |
| 64 = Compatibility = | |
| 65 || trunk || Works || | |
| 66 || 0.10 || Works, requires a storage driver with archive support, eg mod_storage_sql2 in 0.10 || | |
| 67 || 0.9 || Unsupported || | |
| 68 || 0.8 || Does not work || |