Mercurial > prosody-modules

comparison mod_mam_muc/README.markdown @ 4786:016e9c7733bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_mam_muc: Obsolete this module, it is included in Prosody since 0.11 under the name mod_muc_mam
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Fri, 09 Jul 2021 18:31:45 +0200
parents 637d63b7398e
children
comparison
equal deleted inserted replaced
4785:05bea2f43d97 4786:016e9c7733bc
1 --- 1 ---
2 labels: 2 labels:
3 - 'Stage-Merged' 3 - 'Stage-Obsolete'
4 summary: 'XEP-0313: Message Archive Management for MUC' 4 summary: 'XEP-0313: Message Archive Management for MUC'
5 superseded_by: mod_muc_mam
5 ... 6 ...
6 7
7 Introduction 8 Since Prosody 0.11, this module is [included in Prosody](https://prosody.im/doc/modules/mod_muc_mam), you will be redirected there shortly.
8 ============
9
10 This module logs the conversation of chatrooms running on the server to
11 Prosody's archive storage. To access them you will need a client with
12 support for [XEP-0313: Message Archive Management] **version 0.5** or
13 a module such as [mod_http_muc_log].
14
15 Usage
16 =====
17
18 First copy the module to the prosody plugins directory.
19
20 Then add "mam\_muc" to your modules\_enabled list:
21
22 ``` {.lua}
23 Component "conference.example.org" "muc"
24 modules_enabled = {
25 "mam_muc",
26 }
27 ```
28
29 mod\_mam\_muc needs an archive-capable storage module, see
30 [Prosodys storage documentation][doc:storage] for how to select one.
31 The store is called "muc\_log".
32
33 Configuration
34 =============
35
36 Logging needs to be enabled for each room in the room configuration
37 dialog.
38
39 ``` {.lua}
40 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)
41
42 muc_log_all_rooms = false; -- set to true to force logging of all rooms
43
44 -- This is the largest number of messages that are allowed to be retrieved when joining a room.
45 max_history_messages = 20;
46 ```
47
48 Compatibility
49 =============
50
51 ------- -----------------------------------------------------------------------------
52 trunk Use mod\_muc\_mam (included with Prosody)
53 0.11 Use mod\_muc\_mam (included with Prosody)
54 0.10 Works partially, only legacy XEP-0313 (version 0.5, namespace urn:xmpp:mam:1)
55 0.9 Does not work
56 0.8 Does not work
57 ------- -----------------------------------------------------------------------------
58
59 Prosody trunk (after April 2014) has a major rewrite of the MUC module,
60 allowing easier integration, but this module is not compatible with
61 that.