mod_storage_xmlarchive: Add a prosodyctl command for migrating to/from the internal storage format

author: Kim Alvefur <zash@zash.se>
date: Thu, 09 Nov 2017 13:42:35 +0100
parent: 2359:33e85070dc60
child: 2817:f052b62c653c
--- a/mod_storage_xmlarchive/README.markdown	Thu Nov 09 13:41:36 2017 +0100
+++ b/mod_storage_xmlarchive/README.markdown	Thu Nov 09 13:42:35 2017 +0100
@@ -45,3 +45,21 @@
   0.9    Should work
   0.8    Does not work
   ------ ---------------
+
+Conversion to or from internal storage
+--------------------------------------
+
+This module stores data in a way that overlaps with the more recent
+archive support in `mod_storage_internal`, meaning eg [mod\_migrate]
+will not be able to cleanly convert to or from the `xmlarchive` format.
+
+To mitigate this, an migration command has been added to
+`mod_storage_xmlarchive`:
+
+``` bash
+prosodyctl mod_storage_xmlarchive convert $DIR internal $STORE $JID
+```
+
+Where `$DIR` is `to` or `from`, `$STORE` is eg `archive` or `archive2`
+for MAM and `muc_log` for MUC logs. Finally, `$JID` is the JID of the
+user or MUC room to me migrated, which can be repeated.