view mod_mam/README.markdown @ 1804:3228fb928a93

mod_mam/README: Minor fixup
author Kim Alvefur <>
date Sun, 30 Aug 2015 03:05:53 +0200
parents 4d73a1a6ba68
children 8de50be756e5
line wrap: on
line source

- 'Stage-Beta'
summary: 'XEP-0313: Message Archive Management'


Implementation of [XEP-0313: Message Archive


This module will archive all messages that match the simple rules setup
by the user, and allow the user to access this archive.


First copy the module to the prosody plugins directory.

Then add "mam" to your modules\_enabled list:

    modules_enabled = {
        -- ...
        -- ...

Storage backend

mod\_mam uses the store "archive2". See [Prosodys data storage
documentation]( for information on how to
configure storage.

For example, to use mod\_storage\_sql2:

    storage = {
        archive2 = "sql2";


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.

    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.


  ------- --------------------------------------------------------------------------------------
  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
  ------- --------------------------------------------------------------------------------------