annotate mod_mam.wiki @ 285:a1068d19ef5f

mod_mam: Update reference to the now published XEP
author Kim Alvefur <zash@zash.se>
date Fri, 08 Jun 2012 23:59:28 +0200
parents 0558c44908fe
children 27d80566611b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary XEP-xxxx: Message Archive Management (Really)
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
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 The server will archive messages passing through, and clients can query their archive.
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 {{{
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 modules_enabled = {
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 -- ...
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 "mam",
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 -- ...
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 }
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 }}}
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 = Configuration =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
27 {{{
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
28 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
29 }}}
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 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
32
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
33 * `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
34 * `"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
35 * `true` means is to store all messages.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
36
284
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
37 {{{
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
38 max_archive_query_results = 50;
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
39 }}}
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 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
42
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
43
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 = Compatibility =
260
ca66f14190ac Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents: 259
diff changeset
45 || 0.8 || Works ||
ca66f14190ac Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents: 259
diff changeset
46 || 0.9 || Works ||
ca66f14190ac Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents: 259
diff changeset
47 || trunk || Works ||
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 = TODO =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50
251
1da94ec1f030 mod_mam: Fix markdownism
Kim Alvefur <zash@zash.se>
parents: 250
diff changeset
51 * Optimize
1da94ec1f030 mod_mam: Fix markdownism
Kim Alvefur <zash@zash.se>
parents: 250
diff changeset
52 * Use new stanza archive API once it appears
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
53 * Policy enforcing.