Mercurial > prosody-modules
annotate mod_mam_muc/README.markdown @ 2727:91cbeb6ad987
mod_smacks: don't send out <r> when already hibernating
author | tmolitor <thilo@eightysoft.de> |
---|---|
date | Fri, 14 Jul 2017 18:06:17 +0200 |
parents | 02d688ba7739 |
children | 902ecd6400bd |
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: |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
3 - 'Stage-Alpha' |
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 | 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 | 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 |
1958
eb515fbac198
mod_mam_muc/README: Automagic links!
Kim Alvefur <zash@zash.se>
parents:
1821
diff
changeset
|
12 support for [XEP-0313: Message Archive Management] or a module such |
eb515fbac198
mod_mam_muc/README: Automagic links!
Kim Alvefur <zash@zash.se>
parents:
1821
diff
changeset
|
13 as [mod\_http\_muc\_log]. |
1782 | 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 | 17 |
18 First copy the module to the prosody plugins directory. | |
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 | 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 | 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 | 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 | 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 | 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 | 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 | 50 |
1974
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
51 ------- ----------------- |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
52 trunk Works best |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
53 0.10 Works partially |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
54 0.9 Does not work |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
55 0.8 Does not work |
1974
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
56 ------- ----------------- |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
57 |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
58 Prosody trunk (after April 2014) has a major rewrite of the MUC module, |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
59 allowing easier integration. Without this (0.10), some features do not |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1958
diff
changeset
|
60 work, such as correct advertising and join/part logging. |