Mercurial > prosody-modules

annotate mod_muc_archive/README.markdown @ 4432:e83284d4d5c2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_ccert/README: Add setting to ensure Prosdy asks for client certificate This used to be the default for all services, but since it triggers annoying popups in web browsers it was inverted in Prosody and only s2s enables it, so it needs to be explicitly enabled for c2s again. See trunk 115b5e32d960 Thanks debacle
author Kim Alvefur <zash@zash.se>
date Sat, 06 Feb 2021 21:34:25 +0100
parents 7e96b95924bd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3957
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
1 ---
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
2 labels:
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
3 - 'Stage-Beta'
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
4 summary: Log MUC messages to disk
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
5 ...
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
6
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
7 # Introduction
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
8
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
9 This module logs the conversations of chatrooms running on the server to Prosody's data store.
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
10
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
11 This is a fork of [mod_muc_log](https://modules.prosody.im/mod_muc_log.html) which uses the newer storage API.
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
12 This allows you to also log messages to a SQL backend.
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
13
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
14 ## Changes between mod_muc_archive and mod_muc_log:
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
15
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
16 - Use newer module storage API so that you can also store in SQL
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
17 - Adhere to config option `muc_log_all_rooms` (also used by mod_muc_mam)
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
18 - Add affiliation information in the logged stanza
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
19 - Remove code that set (and then removed) an "alreadyJoined" dummy element
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
20
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
21 NOTE: The changes are unlikely to be entirely backwards compatible because the stanza
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
22 being logged is no longer wrapped with `<stanza time=...>`.
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
23
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
24 Details
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
25 =======
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
26
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
27 mod\_muc\_archive must be loaded individually for the components that need it.
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
28
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
29 Assuming you have a MUC component already running on
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
30 conference.example.org then you can add muc\_archive to it like so:
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
31
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
32 Component "conference.example.org" "muc"
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
33 modules_enabled = {
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
34 "muc_archive";
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
35 }
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
36
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
37
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
38 Compatibility
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
39 =============
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
40
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
41 ------ -----
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
42 0.11 Works
7e96b95924bd mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
JC Brand <jc@opkode.com>
parents:
diff changeset
43 ------ -----