Mercurial > prosody-wiki

annotate mod_archive.wiki @ 391:057b3e34e24c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_seclabels: Add code markup
author Kim Alvefur <zash@zash.se>
date Mon, 15 Jul 2013 02:01:24 +0200
parents c929df198f10
children
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
334
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
2 #labels Stage-Unsupported
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
3
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
4 ----
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
5 This page is held here for reference only. mod_archive is no longer supported.
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
6
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
7 Similar modules:
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
8
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
9 * [mod_mam]
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
10 * [mod_mam_sql]
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
11 * [http://prosody.im/files/mod_log_messages.lua mod_log_messages] (mainly useful as a template for people making their own logging module)
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
12
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
13 *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.
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
14
403950aefc52 Update wiki page to reflect mod_archive status and suggest alternatives
MWild1@gmail.com
parents: 198
diff changeset
15 ----
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
16
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
17 = Introduction =
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
18
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
19 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
20
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
21 = Details =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
22
198
757684c251d9 Edited wiki page mod_archive through web user interface.
MWild1
parents: 148
diff changeset
23 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
24
757684c251d9 Edited wiki page mod_archive through web user interface.
MWild1
parents: 148
diff changeset
25 *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
26
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
27 = Usage =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
28
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
29 First copy the module to the prosody plugins directory.
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
30
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
31 Then add "archive" to your modules_enabled list:
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 modules_enabled = {
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
34 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
35 "privacy",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
36 "archive",
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
37 -- ...
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
38 }}}
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
39
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
40 = Configuration =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
41 || *Name* || *Description* || *Type* || *Default value* ||
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
42 || 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
43 || 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
44 || 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
45
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
46
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
47 = Compatibility =
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
48 || 0.7.0 || Works ||
129
3dcf39b5a881 Created wiki page through web user interface.
shinysky1986@gmail.com
parents:
diff changeset
49
131
90f54b821254 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 130
diff changeset
50 = TODO =
148
5d350ab051f8 Edited wiki page through web user interface.
shinysky1986@gmail.com
parents: 132
diff changeset
51 * consider '`exactmatch`' attribute when do JID matching.
373
c929df198f10 Mark pages of modules no longer in the repo as Deprecated
Kim Alvefur <zash@zash.se>
parents: 334
diff changeset
52 * return a `<feature-not-implemented/>` error when the client set the value of the '`save`' attribute to '`stream`'.