prosody-modules
b3dd77f2d0d7
mod_mam_muc/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_mam_muc/README.markdown @ 4219:b3dd77f2d0d7

mod_log_ringbuffer: Switch `filename` to not be interpolated, add filename_template which is
author Matthew Wild <mwild1@gmail.com>
date Fri, 16 Oct 2020 18:41:15 +0100
parent 3666:637d63b7398e
child 4786:016e9c7733bc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
3666
637d63b7398e Mark some modules as Merged
Kim Alvefur <zash@zash.se>
parents: 3467
diff changeset
3 - 'Stage-Merged'
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: 'XEP-0313: Message Archive Management for MUC'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
5 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
7 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
8 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
10 This module logs the conversation of chatrooms running on the server to
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
11 Prosody's archive storage. To access them you will need a client with
3036
f7ebf8fcd602 mod_mam_muc: Remove support for Prosody trunk/0.11
Kim Alvefur <zash@zash.se>
parents: 3005
diff changeset
12 support for [XEP-0313: Message Archive Management] **version 0.5** or
f7ebf8fcd602 mod_mam_muc: Remove support for Prosody trunk/0.11
Kim Alvefur <zash@zash.se>
parents: 3005
diff changeset
13 a module such as [mod_http_muc_log].
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
15 Usage
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
16 =====
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 First copy the module to the prosody plugins directory.
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
20 Then add "mam\_muc" to your modules\_enabled list:
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
22 ``` {.lua}
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
23 Component "conference.example.org" "muc"
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
24 modules_enabled = {
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
25 "mam_muc",
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
26 }
1980
5e0ee0e4d5b1 mod_mam_muc/README: Fix markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1979
diff changeset
27 ```
1979
3a66cff4354f mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents: 1976
diff changeset
28
2328
fbb16ada4580 mod_mam_muc/README: Defer to main documentation site for storage docs
Kim Alvefur <zash@zash.se>
parents: 2327
diff changeset
29 mod\_mam\_muc needs an archive-capable storage module, see
fbb16ada4580 mod_mam_muc/README: Defer to main documentation site for storage docs
Kim Alvefur <zash@zash.se>
parents: 2327
diff changeset
30 [Prosodys storage documentation][doc:storage] for how to select one.
2329
b3fbf9050526 mod_mam_muc/README: Mention store name
Kim Alvefur <zash@zash.se>
parents: 2328
diff changeset
31 The store is called "muc\_log".
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
32
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
33 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
34 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
36 Logging needs to be enabled for each room in the room configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
37 dialog.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
39 ``` {.lua}
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
40 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
42 muc_log_all_rooms = false; -- set to true to force logging of all rooms
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
44 -- This is the largest number of messages that are allowed to be retrieved when joining a room.
2718
02d688ba7739 mod_mam_muc: Make calculation of max history length more like in mod_muc
Kim Alvefur <zash@zash.se>
parents: 2329
diff changeset
45 max_history_messages = 20;
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
46 ```
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
48 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
49 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50
3467
741886d5d84f mod_mam_muc: Mention that this MAM version is legacy.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3466
diff changeset
51 ------- -----------------------------------------------------------------------------
3042
4f215f5227cf mod_mam_muc/README: Add note about mod_muc_mam being included with Prosody
Kim Alvefur <zash@zash.se>
parents: 3036
diff changeset
52 trunk Use mod\_muc\_mam (included with Prosody)
3465
468082a9913c mod_mam_muc: Add compatibility note for 0.11 (thanks Ge0rG!)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3042
diff changeset
53 0.11 Use mod\_muc\_mam (included with Prosody)
3467
741886d5d84f mod_mam_muc: Mention that this MAM version is legacy.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3466
diff changeset
54 0.10 Works partially, only legacy XEP-0313 (version 0.5, namespace urn:xmpp:mam:1)
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
55 0.9 Does not work
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
56 0.8 Does not work
3467
741886d5d84f mod_mam_muc: Mention that this MAM version is legacy.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3466
diff changeset
57 ------- -----------------------------------------------------------------------------
1974
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents: 1958
diff changeset
58
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents: 1958
diff changeset
59 Prosody trunk (after April 2014) has a major rewrite of the MUC module,
3036
f7ebf8fcd602 mod_mam_muc: Remove support for Prosody trunk/0.11
Kim Alvefur <zash@zash.se>
parents: 3005
diff changeset
60 allowing easier integration, but this module is not compatible with
f7ebf8fcd602 mod_mam_muc: Remove support for Prosody trunk/0.11
Kim Alvefur <zash@zash.se>
parents: 3005
diff changeset
61 that.