author | Kim Alvefur <zash@zash.se> |
Thu, 17 Dec 2015 16:53:24 +0100 | |
changeset 1984 | 5e0ee0e4d5b1 |
parent 1983 | 3a66cff4354f |
child 2331 | a348c105e05d |
permissions | -rw-r--r-- |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
1 |
--- |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
2 |
labels: |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
3 |
- 'Stage-Alpha' |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
4 |
summary: 'XEP-0313: Message Archive Management for MUC' |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
5 |
... |
1786 | 6 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
7 |
Introduction |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
8 |
============ |
1786 | 9 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
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:
1786
diff
changeset
|
11 |
Prosody's archive storage. To access them you will need a client with |
1962
eb515fbac198
mod_mam_muc/README: Automagic links!
Kim Alvefur <zash@zash.se>
parents:
1825
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:
1825
diff
changeset
|
13 |
as [mod\_http\_muc\_log]. |
1786 | 14 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
15 |
Usage |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
16 |
===== |
1786 | 17 |
|
18 |
First copy the module to the prosody plugins directory. |
|
19 |
||
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
20 |
Then add "mam\_muc" to your modules\_enabled list: |
1786 | 21 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
22 |
``` {.lua} |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
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:
1807
diff
changeset
|
24 |
modules_enabled = { |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
25 |
"mam_muc", |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
26 |
} |
1984
5e0ee0e4d5b1
mod_mam_muc/README: Fix markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1983
diff
changeset
|
27 |
``` |
1983
3a66cff4354f
mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents:
1980
diff
changeset
|
28 |
|
3a66cff4354f
mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents:
1980
diff
changeset
|
29 |
And configure it to use an archive-capable storage module: |
3a66cff4354f
mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents:
1980
diff
changeset
|
30 |
|
1984
5e0ee0e4d5b1
mod_mam_muc/README: Fix markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1983
diff
changeset
|
31 |
``` {.lua} |
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
32 |
storage = { |
1980
cd36e5bf00b3
Various READMEs: Update to reflect rename of mod_storage_sql2 → mod_storage_sql
Kim Alvefur <zash@zash.se>
parents:
1978
diff
changeset
|
33 |
muc_log = "sql"; -- Requires 0.10 or later |
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
34 |
} |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
35 |
``` |
1786 | 36 |
|
1983
3a66cff4354f
mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents:
1980
diff
changeset
|
37 |
See [Prosodys data storage documentation][doc:storage] for more info on |
3a66cff4354f
mod_mam_muc/README: Try to clarify that storage settings are separate
Kim Alvefur <zash@zash.se>
parents:
1980
diff
changeset
|
38 |
how to configure storage for different plugins. |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
39 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
40 |
Configuration |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
41 |
============= |
1786 | 42 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
43 |
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:
1786
diff
changeset
|
44 |
dialog. |
1786 | 45 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
46 |
``` {.lua} |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
47 |
muc_log_by_default = true; -- Enable logging by default (can be disabled in room config) |
1786 | 48 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
49 |
muc_log_all_rooms = false; -- set to true to force logging of all rooms |
1786 | 50 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
51 |
-- This is the largest number of messages that are allowed to be retrieved in one MAM request. |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
52 |
max_archive_query_results = 20; |
1786 | 53 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
54 |
-- This is the largest number of messages that are allowed to be retrieved when joining a room. |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
55 |
max_history_messages = 1000; |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
56 |
``` |
1786 | 57 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
58 |
Compatibility |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
59 |
============= |
1786 | 60 |
|
1978
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
61 |
------- ----------------- |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
62 |
trunk Works best |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
63 |
0.10 Works partially |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
64 |
0.9 Does not work |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
65 |
0.8 Does not work |
1978
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
66 |
------- ----------------- |
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
67 |
|
5be671db83a3
mod_mam_muc/README: Note about features that rely on trunk mod_muc
Kim Alvefur <zash@zash.se>
parents:
1962
diff
changeset
|
68 |
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:
1962
diff
changeset
|
69 |
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:
1962
diff
changeset
|
70 |
work, such as correct advertising and join/part logging. |