diff mod_migrate/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_migrate/README.wiki@8df071457dee
children 22b799c7b50a
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_migrate/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,29 @@
+---
+labels:
+summary: prosodyctl cross storage driver migration tool
+...
+
+Description
+===========
+
+This module adds a command to `prosodyctl` for copying data between
+storage drivers.
+
+Usage:
+`prosodyctl mod_migrate example.com <source-store> <targer-driver> [users]*`
+
+`<source-store>` would be e.g. `accounts` or `private`
+
+`<target-driver>` is the storage driver to copy data to, sans the
+`mod_storage_` prefix.
+
+The process is something like this:
+
+1.  Decide on the future configuration and add this to your prosody
+    config.
+2.  With Prosody shut down, run
+    `prosodyctl mod_migrate example.com accounts sql`
+3.  Repeat for each store, substituting 'accounts'. E.g. vcards,
+    private...
+4.  Change the `storage` configuration to use the new driver.
+5.  Start prosody again.