view mod_mam_muc/README.markdown @ 3005:902ecd6400bd

mod_mam_muc/README: Clarify that only v0.5 of XEP-0313 is supported when used with Prosody 0.10.x
author Kim Alvefur <zash@zash.se>
date Tue, 17 Apr 2018 14:00:40 +0200
parents 02d688ba7739
children f7ebf8fcd602
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'XEP-0313: Message Archive Management for MUC'
...

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

This module logs the conversation of chatrooms running on the server to
Prosody's archive storage. To access them you will need a client with
support for [XEP-0313: Message Archive Management] or a module such
as [mod\_http\_muc\_log].

Usage
=====

First copy the module to the prosody plugins directory.

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

``` {.lua}
Component "conference.example.org" "muc"
modules_enabled = {
  "mam_muc",
}
```

mod\_mam\_muc needs an archive-capable storage module, see
[Prosodys storage documentation][doc:storage] for how to select one.
The store is called "muc\_log".

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

Logging needs to be enabled for each room in the room configuration
dialog.

``` {.lua}
muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)

muc_log_all_rooms = false; -- set to true to force logging of all rooms

-- This is the largest number of messages that are allowed to be retrieved when joining a room.
max_history_messages = 20;
```

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

  ------- --------------------------------------------
  trunk   Works best
  0.10    Works partially, only XEP-0313 version 0.5
  0.9     Does not work
  0.8     Does not work
  ------- --------------------------------------------

Prosody trunk (after April 2014) has a major rewrite of the MUC module,
allowing easier integration. Without this (0.10), some features do not
work, such as correct advertising and join/part logging.