Software /
code /
prosody-modules
File
mod_mam/README.markdown @ 1832:48125f2c358b
mod_http_muc_log: If archive driver provides the dates method, use it
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 07 Sep 2015 16:27:26 +0200 |
parent | 1820:8de50be756e5 |
child | 1835:6234e67ebe7a |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'XEP-0313: Message Archive Management' ... Introduction ============ Implementation of [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html). Details ======= This module will archive all messages that match the simple rules setup by the user, and allow the user to access this archive. Usage ===== First copy the module to the prosody plugins directory. Then add "mam" to your modules\_enabled list: ``` {.lua} modules_enabled = { -- ... "mam", -- ... } ``` Storage backend =============== mod\_mam uses the store "archive2". See [Prosodys data storage documentation](https://prosody.im/doc/storage) for information on how to configure storage. For example, to use mod\_storage\_sql2: ``` {.lua} storage = { archive2 = "sql2"; } ``` Configuration ============= The MAM protocol includes a method of changing preferences regarding what messages should be stored. This allows users to enable or disable archiving by default, and set rules for specific contacts. This module will log no messages by default, for privacy concerns. If you decide to change this, you should inform your users. ``` {.lua} default_archive_policy = false -- other options are true or "roster"; ``` This controls what messages are archived if the user hasn't set a matching rule, or another personal default. ------------ ------------------------------------------------------ `false` Store no messages. This is the default. `"roster"` Store messages to/from contacts in the users roster. `true` Store all messages. ------------ ------------------------------------------------------ max_archive_query_results = 20; This is the largest number of messages that are allowed to be retrieved in one request. Compatibility ============= ------- -------------------------------------------------------------------------------------- trunk Works 0.10 Works, requires a storage driver with archive support, eg mod\_storage\_sql2 in 0.10 0.9 Unsupported 0.8 Does not work ------- --------------------------------------------------------------------------------------