view mod_archive.wiki @ 154:481b89e8007f

Minor summary fix.
author xdersd
date Tue, 07 Sep 2010 11:26:39 +0000
parents 5d350ab051f8
children 757684c251d9
line wrap: on
line source

#summary XEP-0136: Message Archiving
#labels Stage-Beta

= Introduction =

Currently many XMPP clients save the messages locally and it's not convenient or even possible to retrieve the historical messages, especially when one switches the clients a lot.

So it will be much easier if the XMPP server supports server-side message archiving. In this case, the clients can retrieve archived messages anytime and anywhere. XMPP Extension Proposal XEP-0136 is defined for this purpose. This module is an implementation of [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving].

= Details =

The server will have the ability to archive messages passing through.

= Usage =

First copy the module to the prosody plugins directory.

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

= Configuration =
|| *Name* || *Description* || *Type* || *Default value* ||
|| default_max || the maximum number of items to return when requesting collection list or archived messages || integer || 100 ||
|| force_archiving || archive every message automatically, and do NOT consider the preferences || boolean || false ||
|| auto_archiving_enabled || applied when no any preferences available || boolean || true ||


= Compatibility =
|| 0.7.0 || Works ||

= TODO =
 * consider '`exactmatch`' attribute when do JID matching.
 * return a `<feature-not-implemented/>` error when the client set the value of the '`save`' attribute to '`stream`'.