view mod_mam_muc/README.markdown @ 1976:cd36e5bf00b3

Various READMEs: Update to reflect rename of mod_storage_sql2 → mod_storage_sql
author Kim Alvefur <>
date Thu, 17 Dec 2015 16:48:11 +0100
parents 5be671db83a3
children 3a66cff4354f
line wrap: on
line source

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


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].


First copy the module to the prosody plugins directory.

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

``` {.lua}
Component "" "muc"
modules_enabled = {
storage = {
    muc_log = "sql"; -- Requires 0.10 or later

See [Prosodys data storage
documentation]( for more info on how to
configure storage for different plugins.


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

``` {.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 in one MAM request.
max_archive_query_results = 20;

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


  ------- -----------------
  trunk   Works best
  0.10    Works partially
  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.