Mercurial > prosody-wiki

annotate mod_mam_archive.wiki @ 477:86bd8fbd25bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add page
author Kim Alvefur <zash@zash.se>
date Tue, 19 Aug 2014 16:48:43 +0200
parents 739ba93e66f2
children e6614ea77f9c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
467
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
1 #summary XEP-0136: Message Archiving frontend for mod_mam
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
2 #labels Stage-Alpha
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
3
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
4 = Introduction =
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
5
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
6 Implementation of [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving] for [mod_mam].
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
7
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
8
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
9 = Details =
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
10
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
11 See [mod_mam] for details.
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
12
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
13 = Usage =
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
14
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
15 First configure mod_mam as specified in it's [mod_mam wiki]. Make sure it uses sql2 storage backend.
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
16
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
17 Then add "mam_archive" to your modules_enabled list:
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
18 {{{
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
19 modules_enabled = {
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
20 -- ...
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
21 "mam_archive",
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
22 -- ...
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
23 }
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
24 }}}
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
25
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
26 = Configuration =
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
27
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
28 Because of the fact that [http://xmpp.org/extensions/xep-0136.html XEP-0136] defines a 'conversation' concept not present in [http://xmpp.org/extensions/xep-0313.html XEP-0313], we have to assume some periods of chat history as 'conversations'.
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
29
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
30 Conversation interval defaults to one day, to provide for a convenient usage.
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
31
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
32 {{{
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
33 archive_conversation_interval = 86400; -- defined in seconds. One day by default
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
34 }}}
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
35
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
36 That is the only reason SQL database is required as well.
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
37
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
38 = Compatibility =
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
39 || 0.10 || Works ||
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
40 || 0.9 || Does not work ||
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
41
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
42 || PostgreSQL || Tested ||
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
43 || MySQL || Not tested ||
739ba93e66f2 Created wiki page through web user interface.
alex.bogdanov91@gmail.com
parents:
diff changeset
44 || SQLite || Not tested ||