Mercurial > prosody-modules
comparison mod_muc_archive/README.markdown @ 3957:7e96b95924bd
mod_muc_archive: Add fork of mod_muc_log that uses newer storage API
| author | JC Brand <jc@opkode.com> |
|---|---|
| date | Fri, 27 Mar 2020 15:51:57 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 3956:ebc1f1d962c5 | 3957:7e96b95924bd |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Beta' | |
| 4 summary: Log MUC messages to disk | |
| 5 ... | |
| 6 | |
| 7 # Introduction | |
| 8 | |
| 9 This module logs the conversations of chatrooms running on the server to Prosody's data store. | |
| 10 | |
| 11 This is a fork of [mod_muc_log](https://modules.prosody.im/mod_muc_log.html) which uses the newer storage API. | |
| 12 This allows you to also log messages to a SQL backend. | |
| 13 | |
| 14 ## Changes between mod_muc_archive and mod_muc_log: | |
| 15 | |
| 16 - Use newer module storage API so that you can also store in SQL | |
| 17 - Adhere to config option `muc_log_all_rooms` (also used by mod_muc_mam) | |
| 18 - Add affiliation information in the logged stanza | |
| 19 - Remove code that set (and then removed) an "alreadyJoined" dummy element | |
| 20 | |
| 21 NOTE: The changes are unlikely to be entirely backwards compatible because the stanza | |
| 22 being logged is no longer wrapped with `<stanza time=...>`. | |
| 23 | |
| 24 Details | |
| 25 ======= | |
| 26 | |
| 27 mod\_muc\_archive must be loaded individually for the components that need it. | |
| 28 | |
| 29 Assuming you have a MUC component already running on | |
| 30 conference.example.org then you can add muc\_archive to it like so: | |
| 31 | |
| 32 Component "conference.example.org" "muc" | |
| 33 modules_enabled = { | |
| 34 "muc_archive"; | |
| 35 } | |
| 36 | |
| 37 | |
| 38 Compatibility | |
| 39 ============= | |
| 40 | |
| 41 ------ ----- | |
| 42 0.11 Works | |
| 43 ------ ----- |