Mercurial > prosody-modules

view mod_mam_archive/README.markdown @ 3319:408f92149774

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_cloud_notify: New module Fork of mod_cloud_notify for MUCs.
author JC Brand <jc@opkode.com>
date Fri, 14 Sep 2018 08:02:50 +0000
parents 758a9a723597
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'XEP-0136: Message Archiving frontend for mod\_mam'
...

Introduction
============

Implementation of [XEP-0136: Message
Archiving](http://xmpp.org/extensions/xep-0136.html) for
[mod\_mam](mod_mam.html).

Details
=======

See [mod\_mam] for details.

Usage
=====

First configure mod\_mam as specified in it's [wiki][mod\_mam]. Make
sure it uses sql2 storage backend.

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

        modules_enabled = {
            -- ...
            "mam_archive",
            -- ...
        }

Configuration
=============

Because of the fact that [XEP-0136] defines a 'conversation' concept not
present in [XEP-0313], we have to assume some periods of chat history as
'conversations'.

Conversation interval defaults to one day, to provide for a convenient
usage.

    archive_conversation_interval = 86400; -- defined in seconds. One day by default

That is the only reason SQL database is required as well.

Compatibility
=============

  ------ ---------------
  0.10   Works
  0.9    Does not work
  ------ ---------------

  ------------ ------------
  PostgreSQL   Tested
  MySQL        Not tested
  SQLite       Tested
  ------------ ------------