view @ 198:757684c251d9

Edited wiki page mod_archive through web user interface.
author MWild1
date Tue, 05 Jul 2011 19:02:07 +0000
parents 5d350ab051f8
children 403950aefc52
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.

= Details =

This module keeps an archive of incoming and outgoing messages for each user on the server, and allows the user to query and manage this archive using the XMPP extension described in [ XEP-0136: Message Archiving].

*Note:* If you are an administrator looking for a module just for centrally logging messages passing to/from users on your server, this probably isn't the module you are looking for (mod_archive is for user-managed archives). We'd really like to hear about your requirements to make a module more tailored to this kind of use-case though (especially how/where you would like the messages stored)... drop us an email at to let us know.

= Usage =

First copy the module to the prosody plugins directory.

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

= 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`'.