prosody-modules
8de50be756e5
mod_mam_muc/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_mam_muc/README.markdown @ 1820:8de50be756e5

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
parent 1803:4d73a1a6ba68
child 1821:79b9bd84b91c
comparison
equal deleted inserted replaced
1819:1b08597b5e6f 1820:8de50be756e5
18 18
19 First copy the module to the prosody plugins directory. 19 First copy the module to the prosody plugins directory.
20 20
21 Then add "mam\_muc" to your modules\_enabled list: 21 Then add "mam\_muc" to your modules\_enabled list:
22 22
23 Component "conference.example.org" "muc" 23 ``` {.lua}
24 modules_enabled = { 24 Component "conference.example.org" "muc"
25 "mam_muc", 25 modules_enabled = {
26 } 26 "mam_muc",
27 storage = { 27 }
28 -- This makes mod_mam_muc use the sql2 storage backend (others will use internal) 28 storage = {
29 -- which at the time of this writing is the only one supporting stanza archives 29 -- This makes mod_mam_muc use the sql2 storage backend (others will use internal)
30 muc_log = "sql2"; 30 -- which at the time of this writing is the only one supporting stanza archives
31 } 31 muc_log = "sql2";
32 }
33 ```
32 34
33 See [Prosodys data storage 35 See [Prosodys data storage
34 documentation](https://prosody.im/doc/storage) for more info on how to 36 documentation](https://prosody.im/doc/storage) for more info on how to
35 configure storage for different plugins. 37 configure storage for different plugins.
36 38
38 ============= 40 =============
39 41
40 Logging needs to be enabled for each room in the room configuration 42 Logging needs to be enabled for each room in the room configuration
41 dialog. 43 dialog.
42 44
43 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config) 45 ``` {.lua}
46 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)
44 47
45 muc_log_all_rooms = false; -- set to true to force logging of all rooms 48 muc_log_all_rooms = false; -- set to true to force logging of all rooms
46 49
47 -- This is the largest number of messages that are allowed to be retrieved in one MAM request. 50 -- This is the largest number of messages that are allowed to be retrieved in one MAM request.
48 max_archive_query_results = 20; 51 max_archive_query_results = 20;
49 52
50 -- This is the largest number of messages that are allowed to be retrieved when joining a room. 53 -- This is the largest number of messages that are allowed to be retrieved when joining a room.
51 max_history_messages = 1000; 54 max_history_messages = 1000;
55 ```
52 56
53 Compatibility 57 Compatibility
54 ============= 58 =============
55 59
56 ------- --------------- 60 ------- ---------------