prosody-wiki: mod_mam.wiki annotate

annotate mod_mam.wiki @ 284:0558c44908fe

mod_mam: Something about max_archive_query_results

author	Kim Alvefur <zash@zash.se>
date	Fri, 08 Jun 2012 23:58:10 +0200
parents	ca66f14190ac
children	a1068d19ef5f

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
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	6 Implementation of [http://matthewwild.co.uk/uploads/message-archive-management.html XEP-xxxx: Message Archive Management]. Like [mod_archive] but much simpler.
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	7
250 a711a9d4134d mod_mam: We need bolder, yes! Kim Alvefur <zash@zash.se> parents: 249 diff changeset	8 Note that this is an implementation of a ProtoXEP, which may be subject to major i changes.
249 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 = Details =
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 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	13
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	14 = Usage =
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 First copy the module to the prosody plugins directory.
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 Then add "mam" to your modules_enabled list:
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 modules_enabled = {
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 "mam",
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 }}}
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 = Configuration =
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	28
259 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 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	31 }}}
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 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	34
6fb8d4252b73 Update mod_mam page with default³ info Kim Alvefur <zash@zash.se> parents: 251 diff changeset	35 * `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	36 * `"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	37 * `true` means is to store all messages.
6fb8d4252b73 Update mod_mam page with default³ info Kim Alvefur <zash@zash.se> parents: 251 diff changeset	38
284 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 max_archive_query_results = 50;
0558c44908fe mod_mam: Something about max_archive_query_results Kim Alvefur <zash@zash.se> parents: 260 diff changeset	41 }}}
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 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	44
259 6fb8d4252b73 Update mod_mam page with default³ info Kim Alvefur <zash@zash.se> parents: 251 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 \|\| 0.8 \|\| Works \|\|
ca66f14190ac Brief testing suggests mod_mam works with 0.9 Kim Alvefur <zash@zash.se> parents: 259 diff changeset	48 \|\| 0.9 \|\| Works \|\|
ca66f14190ac Brief testing suggests mod_mam works with 0.9 Kim Alvefur <zash@zash.se> parents: 259 diff changeset	49 \|\| trunk \|\| Works \|\|
249 963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	50
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	51 = TODO =
963ae0ff05b0 Add page for mod_mam Kim Alvefur <zash@zash.se> parents: diff changeset	52
251 1da94ec1f030 mod_mam: Fix markdownism Kim Alvefur <zash@zash.se> parents: 250 diff changeset	53 * Optimize
1da94ec1f030 mod_mam: Fix markdownism Kim Alvefur <zash@zash.se> parents: 250 diff changeset	54 * 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	55 * Policy enforcing.

Mercurial > prosody-wiki

annotate mod_mam.wiki @ 284:0558c44908fe