Mercurial > prosody-modules

comparison mod_mam_archive/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_mam_archive/README.wiki@29f3d6b7ad16
children 79b9bd84b91c
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'XEP-0136: Message Archiving frontend for mod\_mam'
5 ...
6
7 Introduction
8 ============
9
10 Implementation of [XEP-0136: Message
11 Archiving](http://xmpp.org/extensions/xep-0136.html) for
12 [mod\_mam](mod_mam.md).
13
14 Details
15 =======
16
17 See [mod\_mam](mod_mam.md) for details.
18
19 Usage
20 =====
21
22 First configure mod\_mam as specified in it's [wiki](mod_mam.md). Make
23 sure it uses sql2 storage backend.
24
25 Then add "mam\_archive" to your modules\_enabled list:
26
27 modules_enabled = {
28 -- ...
29 "mam_archive",
30 -- ...
31 }
32
33 Configuration
34 =============
35
36 Because of the fact that
37 [XEP-0136](http://xmpp.org/extensions/xep-0136.html) defines a
38 'conversation' concept not present in
39 [XEP-0313](http://xmpp.org/extensions/xep-0313.html), we have to assume
40 some periods of chat history as 'conversations'.
41
42 Conversation interval defaults to one day, to provide for a convenient
43 usage.
44
45 archive_conversation_interval = 86400; -- defined in seconds. One day by default
46
47 That is the only reason SQL database is required as well.
48
49 Compatibility
50 =============
51
52 ------ ---------------
53 0.10 Works
54 0.9 Does not work
55 ------ ---------------
56
57 ------------ ------------
58 PostgreSQL Tested
59 MySQL Not tested
60 SQLite Tested
61 ------------ ------------