This is an automated email from the ASF dual-hosted git repository.
humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git
The following commit(s) were added to refs/heads/master by this push:
new 321db4f Start doc on migrating from PM to Foal
321db4f is described below
commit 321db4fc38ca8400f32062baea06fd9e4c287f80
Author: Daniel Gruno <[email protected]>
AuthorDate: Wed Sep 9 14:02:35 2020 +0200
Start doc on migrating from PM to Foal
---
INSTALL.md | 3 ++-
MIGRATING.md | 22 ++++++++++++++++++++++
2 files changed, 24 insertions(+), 1 deletion(-)
diff --git a/INSTALL.md b/INSTALL.md
index eaacf94..37071dc 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -33,7 +33,8 @@ cd tools/
python3 setup.py
cd ..
~~~
-- Import any mailboxes you need to, using `tools/import-mbox.py`
+- Import any mailboxes you need to, using `tools/import-mbox.py` OR migrate
your old Pony Mail database
+ using the [Foal migrator](MIGRATING.md).
- Install the server requirements:
~~~shell script
cd server/
diff --git a/MIGRATING.md b/MIGRATING.md
new file mode 100644
index 0000000..00d4921
--- /dev/null
+++ b/MIGRATING.md
@@ -0,0 +1,22 @@
+# Migrating from an old Pony Mail database to Foal
+
+To migrate your database, you will need the following:
+
+- Access to the original ES 2.x/5.x database
+- Access to the new ES 7.x/8.x database
+- Foal fully installed with a new database set up on the ES 7.x+ instance.
+
+Once you have all this at the ready, run the migrator script:
+~~~shell script
+cd server/
+pipenv run python3 migrate.py
+~~~
+You will need to enter the URL of the old server as well as the new server,
+and the name of the old database and the prefix of the new indices.
+
+You will also need to acknowledge the DKIm re-indexing, or deny it and
+continue with the old document IDs. Re-indexing is recommended if you wish
+to use shorted permalinks, and is fully backwards-compatible with your
+previous permalinks.
+
+Migrating may take quite a while. Assume 250 documents can be migrated per
second.
