| author | Kim Alvefur <zash@zash.se> |
| Wed, 09 Sep 2015 15:27:31 +0200 | |
| changeset 1839 | 6234e67ebe7a |
| parent 1824 | 8de50be756e5 |
| child 1980 | cd36e5bf00b3 |
| permissions | -rw-r--r-- |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
1 |
--- |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
2 |
labels: |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
3 |
- 'Stage-Beta' |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
4 |
summary: 'XEP-0313: Message Archive Management' |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
5 |
... |
| 1786 | 6 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
7 |
Introduction |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
8 |
============ |
| 1786 | 9 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
10 |
Implementation of [XEP-0313: Message Archive |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
11 |
Management](http://xmpp.org/extensions/xep-0313.html). |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
12 |
|
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
13 |
Details |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
14 |
======= |
| 1786 | 15 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
16 |
This module will archive all messages that match the simple rules setup |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
17 |
by the user, and allow the user to access this archive. |
| 1786 | 18 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
19 |
Usage |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
20 |
===== |
| 1786 | 21 |
|
22 |
First copy the module to the prosody plugins directory. |
|
23 |
||
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
24 |
Then add "mam" to your modules\_enabled list: |
| 1786 | 25 |
|
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
26 |
``` {.lua} |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
27 |
modules_enabled = { |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
28 |
-- ... |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
29 |
"mam", |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
30 |
-- ... |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
31 |
} |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
32 |
``` |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
33 |
|
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
34 |
Configuration |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
35 |
============= |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
36 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
37 |
Storage backend |
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
38 |
--------------- |
| 1786 | 39 |
|
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
40 |
mod\_mam uses the store "archive2"[^1]. See [Prosodys data storage |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
41 |
documentation](https://prosody.im/doc/storage) for information on how to |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
42 |
configure storage. |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
43 |
|
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
44 |
For example, to use mod\_storage\_sql2[^2]: |
| 1786 | 45 |
|
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
46 |
``` {.lua} |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
47 |
storage = { |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
48 |
archive2 = "sql2"; |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
49 |
} |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1808
diff
changeset
|
50 |
``` |
|
1805
5abf61915ab4
mod_mam/README: Add example of use with mod_storage_sql2
Kim Alvefur <zash@zash.se>
parents:
1786
diff
changeset
|
51 |
|
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
52 |
Query size limits |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
53 |
----------------- |
| 1786 | 54 |
|
| 1808 | 55 |
max_archive_query_results = 20; |
| 1786 | 56 |
|
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
57 |
This is the largest number of messages that are allowed to be retrieved |
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
58 |
in one request *page*. A query that does not fit in one page will |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
59 |
include a reference to the next page, letting clients page through the |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
60 |
result set. Setting large number is not recomended, as Prosody will be |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
61 |
blocked while processing the request and will not be able to do anything |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
62 |
else. |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
63 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
64 |
Message matching policy |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
65 |
----------------------- |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
66 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
67 |
The MAM protocol includes a way for clients to control what messages |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
68 |
should be stored. This allows users to enable or disable archiving by |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
69 |
default or for specific contacts. This module will log no messages by |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
70 |
default, for privacy concerns. If you decide to change this, you should |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
71 |
inform your users. |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
72 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
73 |
``` {.lua} |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
74 |
default_archive_policy = false |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
75 |
``` |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
76 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
77 |
`default_archive_policy =` Meaning |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
78 |
---------------------------- ------------------------------------------------------ |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
79 |
`false` Store no messages. This is the default. |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
80 |
`"roster"` Store messages to/from contacts in the users roster. |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
81 |
`true` Store all messages. |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
82 |
|
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
83 |
Compatibility |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
84 |
============= |
| 1786 | 85 |
|
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
86 |
------- --------------- |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
87 |
trunk Works |
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
88 |
0.10 Works [^3] |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
89 |
0.9 Unsupported |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1805
diff
changeset
|
90 |
0.8 Does not work |
|
1839
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
91 |
------- --------------- |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
92 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
93 |
[^1]: Might be changed to "mam" at some point |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
94 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
95 |
[^2]: mod\_storage\_sql2 will replace mod\_storage\_sql at some point |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
96 |
|
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
97 |
[^3]: requires a storage driver with archive support, eg |
|
6234e67ebe7a
mod_mam/README: Reorganise config options under sub-headings and rewrite description of options
Kim Alvefur <zash@zash.se>
parents:
1824
diff
changeset
|
98 |
mod\_storage\_sql2 in 0.10 |