prosody-modules: mod_mam_muc/README.markdown annotate

annotate mod_mam_muc/README.markdown @ 2608:362ca94192ee

mod_smacks: Add resumed session to event "smacks-hibernation-end" Older versions of this event only have the "intermediate" session in event.session (the one used to resume the existing session), but not the resumed one. This adds event.resumed which contains the resumed one alongside to event.session.

author	tmolitor <thilo@eightysoft.de>
date	Sat, 11 Mar 2017 01:37:28 +0100
parents	b3fbf9050526
children	02d688ba7739

rev	line source
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	3 - 'Stage-Alpha'
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	4 summary: 'XEP-0313: Message Archive Management for MUC'
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	5 ...
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	6
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	7 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	8 ============
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	9
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	10 This module logs the conversation of chatrooms running on the server to
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	11 Prosody's archive storage. To access them you will need a client with
1958 eb515fbac198 mod_mam_muc/README: Automagic links! Kim Alvefur <zash@zash.se> parents: 1821 diff changeset	12 support for [XEP-0313: Message Archive Management] or a module such
eb515fbac198 mod_mam_muc/README: Automagic links! Kim Alvefur <zash@zash.se> parents: 1821 diff changeset	13 as [mod\_http\_muc\_log].
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	14
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	15 Usage
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	16 =====
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	17
29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	18 First copy the module to the prosody plugins directory.
29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	19
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	20 Then add "mam\_muc" to your modules\_enabled list:
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	21
1820 8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	22 ``` {.lua}
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	23 Component "conference.example.org" "muc"
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	24 modules_enabled = {
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	25 "mam_muc",
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	26 }
1980 5e0ee0e4d5b1 mod_mam_muc/README: Fix markdown syntax Kim Alvefur <zash@zash.se> parents: 1979 diff changeset	27 ```
1979 3a66cff4354f mod_mam_muc/README: Try to clarify that storage settings are separate Kim Alvefur <zash@zash.se> parents: 1976 diff changeset	28
2328 fbb16ada4580 mod_mam_muc/README: Defer to main documentation site for storage docs Kim Alvefur <zash@zash.se> parents: 2327 diff changeset	29 mod\_mam\_muc needs an archive-capable storage module, see
fbb16ada4580 mod_mam_muc/README: Defer to main documentation site for storage docs Kim Alvefur <zash@zash.se> parents: 2327 diff changeset	30 [Prosodys storage documentation][doc:storage] for how to select one.
2329 b3fbf9050526 mod_mam_muc/README: Mention store name Kim Alvefur <zash@zash.se> parents: 2328 diff changeset	31 The store is called "muc\_log".
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	32
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	33 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	34 =============
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	35
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	36 Logging needs to be enabled for each room in the room configuration
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	37 dialog.
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	38
1820 8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	39 ``` {.lua}
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	40 muc_log_by_default = true; -- Enable logging by default (can be disabled in room config)
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	41
1820 8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	42 muc_log_all_rooms = false; -- set to true to force logging of all rooms
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	43
1820 8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	44 -- This is the largest number of messages that are allowed to be retrieved in one MAM request.
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	45 max_archive_query_results = 20;
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	46
1820 8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	47 -- This is the largest number of messages that are allowed to be retrieved when joining a room.
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	48 max_history_messages = 1000;
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes Kim Alvefur <zash@zash.se> parents: 1803 diff changeset	49 ```
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	50
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	51 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	52 =============
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	53
1974 5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	54 ------- -----------------
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	55 trunk Works best
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	56 0.10 Works partially
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	57 0.9 Does not work
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	58 0.8 Does not work
1974 5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	59 ------- -----------------
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	60
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	61 Prosody trunk (after April 2014) has a major rewrite of the MUC module,
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	62 allowing easier integration. Without this (0.10), some features do not
5be671db83a3 mod_mam_muc/README: Note about features that rely on trunk mod_muc Kim Alvefur <zash@zash.se> parents: 1958 diff changeset	63 work, such as correct advertising and join/part logging.

Mercurial > prosody-modules

annotate mod_mam_muc/README.markdown @ 2608:362ca94192ee