view mod_mam.wiki @ 284:0558c44908fe

mod_mam: Something about max_archive_query_results
author Kim Alvefur <zash@zash.se>
date Fri, 08 Jun 2012 23:58:10 +0200
parents ca66f14190ac
children a1068d19ef5f
line wrap: on
line source

#summary XEP-xxxx: Message Archive Management (Really)
#labels Stage-Alpha

= Introduction =

Implementation of [http://matthewwild.co.uk/uploads/message-archive-management.html XEP-xxxx: Message Archive Management]. Like [mod_archive] but much simpler.

*Note that this is an implementation of a ProtoXEP, which may be subject to major i changes.*

= Details =

The server will archive messages passing through, and clients can query their archive.

= Usage =

First copy the module to the prosody plugins directory.

Then add "mam" to your modules_enabled list:
{{{
    modules_enabled = {
                    -- ...
                    "mam",
                    -- ...
		}
}}}

= Configuration =

{{{
	default_archive_policy = true or false or "roster";
}}}

This controls what messages are archived if the user hasn't set a matching rule, or another personal default.

 * `false` means to store no messages. This is the built in default.
 * `"roster"` means to store messages to/from contacts in the users roster.
 * `true` means is to store all messages.

{{{
	max_archive_query_results = 50;
}}}

This is the largest number of messages that are allowed to be retrieved in one request.


= Compatibility =
|| 0.8 || Works ||
|| 0.9 || Works ||
|| trunk || Works ||

= TODO =

	* Optimize
	* Use new stanza archive API once it appears
	* Policy enforcing.