annotate mod_mam.wiki @ 502:3c81d8a9f1e2

Documentation for the new mod_admin_message module.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:07:33 +0000
parents cd074071ac43
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
501
cd074071ac43 mod_mam: update
Kim Alvefur <zash@zash.se>
parents: 485
diff changeset
1 #summary XEP-0313: Message Archive Management
cd074071ac43 mod_mam: update
Kim Alvefur <zash@zash.se>
parents: 485
diff changeset
2 #labels Stage-Beta
249
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
501
cd074071ac43 mod_mam: update
Kim Alvefur <zash@zash.se>
parents: 485
diff changeset
6 Implementation of [http://xmpp.org/extensions/xep-0313.html XEP-0313: Message Archive Management].
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
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
10 This module will archive all messages that match the simple rules setup by the
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
11 user, and allow the user to access this archive.
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 = Usage =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 First copy the module to the prosody plugins directory.
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 Then add "mam" to your modules_enabled list:
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 {{{
387
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
19 modules_enabled = {
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
20 -- ...
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
21 "mam",
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 }
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
24 storage = {
444
b2ebc4473c4c mod_mam: Add note about storage config example
Kim Alvefur <zash@zash.se>
parents: 413
diff changeset
25 -- This makes mod_mam use the sql2 storage backend (others will use internal)
501
cd074071ac43 mod_mam: update
Kim Alvefur <zash@zash.se>
parents: 485
diff changeset
26 -- which at the time of this writing is the only one supporting stanza archives
387
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
27 archive2 = "sql2";
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
28 }
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 }}}
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
452
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
31 See [https://prosody.im/doc/storage Prosodys data storage documentation]
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
32 for more info on how to configure storage for different plugins.
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
33
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 = Configuration =
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
485
1adeefc201d5 mod_mam: Fix typo
quae@daurnimator.com
parents: 452
diff changeset
36 The MAM protocol includes a method of changing preferences regarding what
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
37 messages should be stored. This allows users to enable or disable
452
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
38 archiving by default, and set rules for specific contacts. This module
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
39 will log no messages by default, for privacy concerns. If you decide to
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
40 change this, you should inform your users.
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
41
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
42 {{{
452
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
43 default_archive_policy = false -- other options are true or "roster";
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
44 }}}
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
45
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
46 This controls what messages are archived if the user hasn't set a
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
47 matching rule, or another personal default.
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
48
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
49 * `false` means to store no messages. This is the default.
259
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
50 * `"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
51 * `true` means is to store all messages.
6fb8d4252b73 Update mod_mam page with default³ info
Kim Alvefur <zash@zash.se>
parents: 251
diff changeset
52
284
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
53 {{{
452
416ec6673229 mod_mam: Clarify some options
Kim Alvefur <zash@zash.se>
parents: 444
diff changeset
54 max_archive_query_results = 20;
284
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
55 }}}
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
56
0558c44908fe mod_mam: Something about max_archive_query_results
Kim Alvefur <zash@zash.se>
parents: 260
diff changeset
57 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
58
249
963ae0ff05b0 Add page for mod_mam
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59 = Compatibility =
260
ca66f14190ac Brief testing suggests mod_mam works with 0.9
Kim Alvefur <zash@zash.se>
parents: 259
diff changeset
60 || trunk || Works ||
413
56912134d96b moar rant
Kim Alvefur <zash@zash.se>
parents: 387
diff changeset
61 || 0.10 || Works ||
387
6f559c056dc8 Update for sql2 change.
Kim Alvefur <zash@zash.se>
parents: 296
diff changeset
62 || 0.9 || Does not work ||
501
cd074071ac43 mod_mam: update
Kim Alvefur <zash@zash.se>
parents: 485
diff changeset
63 || 0.8 || Does not work ||