Mercurial > prosody-modules
view mod_mam_muc/README.markdown @ 2343:f4ab0966ba89
mod_storage_xmlarchive: Fix name in datamanager monkeypatch (fixes #774)
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 04 Nov 2016 19:14:05 +0100 |
parents | b3fbf9050526 |
children | 02d688ba7739 |
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 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; ``` Compatibility ============= ------- ----------------- 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.