annotate mod_archive.wiki @ 332:0ac4abca2fd6

changed mod_bidi.wiki
author Kim Alvefur <zash@zash.se>
date Mon, 25 Mar 2013 04:10:16 +0100
parents 757684c251d9
children 403950aefc52
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
1 #summary XEP-0136: Message Archiving
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
2 #labels Stage-Beta
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
3
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
4 = Introduction =
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
5
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
6 Currently many XMPP clients save the messages locally and it's not convenient or even possible to retrieve the historical messages, especially when one switches the clients a lot.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
7
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
8 = Details =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
9
198
757684c251d9 Edited wiki page mod_archive through web user interface.
MWild1
parents: 148
diff changeset
10 This module keeps an archive of incoming and outgoing messages for each user on the server, and allows the user to query and manage this archive using the XMPP extension described in [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving].
757684c251d9 Edited wiki page mod_archive through web user interface.
MWild1
parents: 148
diff changeset
11
757684c251d9 Edited wiki page mod_archive through web user interface.
MWild1
parents: 148
diff changeset
12 *Note:* If you are an administrator looking for a module just for centrally logging messages passing to/from users on your server, this probably isn't the module you are looking for (mod_archive is for user-managed archives). We'd really like to hear about your requirements to make a module more tailored to this kind of use-case though (especially how/where you would like the messages stored)... drop us an email at developers@prosody.im to let us know.
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
13
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
14 = Usage =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
15
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
16 First copy the module to the prosody plugins directory.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
17
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
18 Then add "archive" to your modules_enabled list:
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
19 {{{
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
20 modules_enabled = {
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
21 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
22 "privacy",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
23 "archive",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
24 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
25 }}}
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
26
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
27 = Configuration =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
28 || *Name* || *Description* || *Type* || *Default value* ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
29 || default_max || the maximum number of items to return when requesting collection list or archived messages || integer || 100 ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
30 || force_archiving || archive every message automatically, and do NOT consider the preferences || boolean || false ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
31 || auto_archiving_enabled || applied when no any preferences available || boolean || true ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
32
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
33
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
34 = Compatibility =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
35 || 0.7.0 || Works ||
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
36
131
90f54b821254 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 130
diff changeset
37 = TODO =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
38 * consider '`exactmatch`' attribute when do JID matching.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
39 * return a `<feature-not-implemented/>` error when the client set the value of the '`save`' attribute to '`stream`'.