annotate mod_mam.wiki @ 411:8b4e2a05f450

update mod_muc_log_http for 0.9+
author Kim Alvefur <zash@zash.se>
date Thu, 16 Jan 2014 23:56:52 +0100
parents 6f559c056dc8
children 56912134d96b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
296
fc11f3985d9b It got published, and a number already
Kim Alvefur <zash@zash.se>
parents: 286
diff changeset
1 #summary XEP-0313: Message Archive Management (Really)
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 #labels Stage-Alpha
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 = Introduction =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
285
a1068d19ef5f mod_mam: Update reference to the now published XEP
Kim Alvefur <zash@zash.se>
parents: 284
diff changeset
6 Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management]. Like [mod_archive] but much simpler.
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 = Details =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
286
27d80566611b mod_mam: Re-write the Details section to be more accurate with current behaviour
Kim Alvefur <zash@zash.se>
parents: 285
diff changeset
10 This module will archive all messages that match the simple rules setup by the user, and allow the user to access this archive.
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 = Usage =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 First copy the module to the prosody plugins directory.
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 Then add "mam" to your modules_enabled list:
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 {{{
387
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
18 modules_enabled = {
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
19 -- ...
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
20 "mam",
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
21 -- ...
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
22 }
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
23 storage = {
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
24 archive2 = "sql2";
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
25 }
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 }}}
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 = Configuration =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
30 {{{
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
31 default_archive_policy = true or false or "roster";
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
32 }}}
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
33
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
34 This controls what messages are archived if the user hasn't set a matching rule, or another personal default.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
35
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
36 * `false` means to store no messages. This is the built in default.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
37 * `"roster"` means to store messages to/from contacts in the users roster.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
38 * `true` means is to store all messages.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
39
284
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
40 {{{
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
41 max_archive_query_results = 50;
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
42 }}}
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
43
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
44 This is the largest number of messages that are allowed to be retrieved in one request.
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
45
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46 = Compatibility =
260
ca66f14190ac Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents: 259
diff changeset
47 || trunk || Works ||
387
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
48 || 0.9 || Does not work ||
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
49 || 0.8 || Does not work ||