author | Kim Alvefur <zash@zash.se> |
Fri, 04 Sep 2015 00:12:13 +0200 | |
changeset 1830 | ae2235d6c3f8 |
parent 1818 | 7b4e841dcd77 |
child 1980 | cd36e5bf00b3 |
permissions | -rw-r--r-- |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
1 |
--- |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
2 |
summary: prosodyctl cross storage driver migration tool |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
3 |
... |
1795
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 |
|
1818
7b4e841dcd77
mod_migrate/README: Change headings and adjust usage string
Kim Alvefur <zash@zash.se>
parents:
1817
diff
changeset
|
5 |
Introduction |
7b4e841dcd77
mod_migrate/README: Change headings and adjust usage string
Kim Alvefur <zash@zash.se>
parents:
1817
diff
changeset
|
6 |
============ |
1795
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
8 |
This module adds a command to `prosodyctl` for copying data between |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
9 |
storage drivers. |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
10 |
|
1818
7b4e841dcd77
mod_migrate/README: Change headings and adjust usage string
Kim Alvefur <zash@zash.se>
parents:
1817
diff
changeset
|
11 |
Usage |
7b4e841dcd77
mod_migrate/README: Change headings and adjust usage string
Kim Alvefur <zash@zash.se>
parents:
1817
diff
changeset
|
12 |
===== |
1817
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
13 |
|
1818
7b4e841dcd77
mod_migrate/README: Change headings and adjust usage string
Kim Alvefur <zash@zash.se>
parents:
1817
diff
changeset
|
14 |
prosodyctl mod_migrate example.com <source-store>[-<store-type>] <target-driver> [users]* |
1795
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
1817
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
16 |
`<source-store>` would be e.g. `accounts` or `private`. To migrate |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
17 |
archives, the optional suffix `<store-type>` would be set to `archive`, |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
18 |
so e.g. `archive2-archive` or `muc_log-archive`. |
1795
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 |
|
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
20 |
`<target-driver>` is the storage driver to copy data to, sans the |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
21 |
`mod_storage_` prefix. |
1795
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 |
|
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 |
The process is something like this: |
8df071457dee
mod_migrate: Provides a prosodyctl mod_migrate command for copying data between storage backends
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 |
|
1817
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
25 |
1. Decide on the future configuration and add for example SQL |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
26 |
connection details to your prosody config, but don't change the |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
27 |
`store` option yet. |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
28 |
2. With Prosody shut down, run |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
29 |
`prosodyctl mod_migrate example.com accounts sql` |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
30 |
3. Repeat for each store, substituting 'accounts'. E.g. vcards, |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
31 |
private... |
1817
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
32 |
4. Change the [`storage` configuration](https://prosody.im/doc/storage) |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
33 |
to use the new driver. |
1807
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1795
diff
changeset
|
34 |
5. Start prosody again. |
1817
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
35 |
|
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
36 |
Examples |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
37 |
======== |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
38 |
|
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
39 |
for store in accounts roster private blocklist vcard archive2-archive; do |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
40 |
prosodyctl migrate example.com $store sql2 |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
41 |
done |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
42 |
|
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
43 |
Compatibility |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
44 |
============= |
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
45 |
|
f02f52a2ee11
mod_migrate: Add support for migrating archives
Kim Alvefur <zash@zash.se>
parents:
1816
diff
changeset
|
46 |
Should work with 0.8 and later. |