Diff

mod_storage_muc_log/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 3457:058844edcaaf
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_muc_log/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,43 @@
+---
+labels:
+- 'Stage-Alpha'
+- ArchiveStorage
+summary: 'Storage module using mod\_muc\_log data with new stanza archive API'
+---
+
+Introduction
+============
+
+[mod\_muc\_log] provided logging of chatrooms running on the server to
+Prosody's data store. This module gives access to this data using the
+0.10+ stanza archive API, allowing legacy log data to be used with
+[mod\_mam\_muc] and [mod\_http\_muc\_log].
+
+Details
+=======
+
+Replace [mod\_muc\_log] and [mod\_muc\_log\_http] in your config
+with
+
+``` {.lua}
+Component "conference.example.org" "muc"
+modules_enabled = {
+  -- "muc_log"; -- functionality replaced by mod_mam_muc + mod_storage_muc_log
+    "mam_muc"; -- Does logging to storage backend configured below
+
+    -- "muc_log_http"; -- Replaced by the mod_http_muc_log
+    "http_muc_log";
+}
+storage = {
+  muc_log = "muc_log";
+}
+```
+
+Compatibility
+=============
+
+  version   status
+  --------- ---------------
+  0.9       unknown
+  0.10      works
+  0.11      does not work