Mercurial > prosody-modules

comparison mod_mam/README.markdown @ 1820:8de50be756e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Various README files: Correct indentation levels, fix syntax and other small fixes
author Kim Alvefur <zash@zash.se>
date Wed, 02 Sep 2015 17:30:33 +0200
parents 3228fb928a93
children 6234e67ebe7a
comparison
equal deleted inserted replaced
1819:1b08597b5e6f 1820:8de50be756e5
21 21
22 First copy the module to the prosody plugins directory. 22 First copy the module to the prosody plugins directory.
23 23
24 Then add "mam" to your modules\_enabled list: 24 Then add "mam" to your modules\_enabled list:
25 25
26 modules_enabled = { 26 ``` {.lua}
27 -- ... 27 modules_enabled = {
28 "mam", 28 -- ...
29 -- ... 29 "mam",
30 } 30 -- ...
31 }
32 ```
31 33
32 Storage backend 34 Storage backend
33 =============== 35 ===============
34 36
35 mod\_mam uses the store "archive2". See [Prosodys data storage 37 mod\_mam uses the store "archive2". See [Prosodys data storage
36 documentation](https://prosody.im/doc/storage) for information on how to 38 documentation](https://prosody.im/doc/storage) for information on how to
37 configure storage. 39 configure storage.
38 40
39 For example, to use mod\_storage\_sql2: 41 For example, to use mod\_storage\_sql2:
40 42
41 storage = { 43 ``` {.lua}
42 archive2 = "sql2"; 44 storage = {
43 } 45 archive2 = "sql2";
46 }
47 ```
44 48
45 Configuration 49 Configuration
46 ============= 50 =============
47 51
48 The MAM protocol includes a method of changing preferences regarding 52 The MAM protocol includes a method of changing preferences regarding
49 what messages should be stored. This allows users to enable or disable 53 what messages should be stored. This allows users to enable or disable
50 archiving by default, and set rules for specific contacts. This module 54 archiving by default, and set rules for specific contacts. This module
51 will log no messages by default, for privacy concerns. If you decide to 55 will log no messages by default, for privacy concerns. If you decide to
52 change this, you should inform your users. 56 change this, you should inform your users.
53 57
54 default_archive_policy = false -- other options are true or "roster"; 58 ``` {.lua}
59 default_archive_policy = false -- other options are true or "roster";
60 ```
55 61
56 This controls what messages are archived if the user hasn't set a 62 This controls what messages are archived if the user hasn't set a
57 matching rule, or another personal default. 63 matching rule, or another personal default.
58 64
59 ------------ ------------------------------------------------------ 65 ------------ ------------------------------------------------------