diff mod_storage_muc_log/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_storage_muc_log/README.wiki@29f3d6b7ad16
children 8de50be756e5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_muc_log/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,37 @@
+---
+labels:
+- 'Stage-Alpha'
+- ArchiveStorage
+summary: 'Storage module using mod\_muc\_log data with new stanza archive API'
+...
+
+Introduction
+============
+
+[mod\_muc\_log](mod_muc_log.md) 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](mod_mam_muc.md) and
+[mod\_http\_muc\_log](mod_http_muc_log.md).
+
+Details
+=======
+
+Replace mod\_muc\_log (and mod\_muc\_log\_http) in your config with
+
+    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
+=============
+
+Requires Prosody 0.10 or above.