diff mod_mam_adhoc.wiki @ 302:275c3ab5805b

Add page for mod_mam_adhoc
author Kim Alvefur <zash@zash.se>
date Mon, 20 Aug 2012 13:49:25 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_mam_adhoc.wiki	Mon Aug 20 13:49:25 2012 +0200
@@ -0,0 +1,25 @@
+#summary Ad-hoc interface to Message Archive Management Settings
+#labels Stage-Alpha
+
+= Introduction =
+
+This module complements mod_mam by allowing clients to change archiving preferences through an Ad-hoc command.
+
+= Details =
+
+When enabled, an "Archive Settings" command should appear in the list of Ad-hoc commands available.  This allows the user to change default policy (always, never, roster) and which JIDs to always store or never store.
+
+= Usage =
+
+First copy the module to the prosody plugins directory.
+
+Then add "mam_adhoc" to your modules_enabled list:
+{{{
+    modules_enabled = {
+                    -- ...
+                    "mam",
+                    "mam_adhoc",
+                    -- ...
+		}
+}}}
+