Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_mam_archive/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,61 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: 'XEP-0136: Message Archiving frontend for mod\_mam'
+...
+
+Introduction
+============
+
+Implementation of [XEP-0136: Message
+Archiving](http://xmpp.org/extensions/xep-0136.html) for
+[mod\_mam](mod_mam.md).
+
+Details
+=======
+
+See [mod\_mam](mod_mam.md) for details.
+
+Usage
+=====
+
+First configure mod\_mam as specified in it's [wiki](mod_mam.md). Make
+sure it uses sql2 storage backend.
+
+Then add "mam\_archive" to your modules\_enabled list:
+
+        modules_enabled = {
+            -- ...
+            "mam_archive",
+            -- ...
+        }
+
+Configuration
+=============
+
+Because of the fact that
+[XEP-0136](http://xmpp.org/extensions/xep-0136.html) defines a
+'conversation' concept not present in
+[XEP-0313](http://xmpp.org/extensions/xep-0313.html), we have to assume
+some periods of chat history as 'conversations'.
+
+Conversation interval defaults to one day, to provide for a convenient
+usage.
+
+    archive_conversation_interval = 86400; -- defined in seconds. One day by default
+
+That is the only reason SQL database is required as well.
+
+Compatibility
+=============
+
+  ------ ---------------
+  0.10   Works
+  0.9    Does not work
+  ------ ---------------
+
+  ------------ ------------
+  PostgreSQL   Tested
+  MySQL        Not tested
+  SQLite       Tested
+  ------------ ------------