From 68a0e93b79e8e80a6da21874e5bf22446223107e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Wed, 30 Dec 2020 09:45:47 +0100 Subject: [PATCH] Document usage --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 025fdd8..8b53e3d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Request tracker to Zammad migration script. This is not an out of box solution for everybody, you will probably have to customize it. -Known issues: +## Known issues * Disabled users from RT can not be accessed by API, thus will lack email address and will fail to be created. Enable all users prior to the migration. @@ -15,6 +15,17 @@ Known issues: * Safer approach might be to use own SMTP server and temporarily discard all mail from Zammad for the migration run. +## Maintenance status + No further development is expected there. This was used once to migrate [Weblate](https://weblate.org/) and I have no intent to improve this script myself. Pull requests are still welcome though. + +## Usage + +1. Prepare virtualenv and install dependencies: `virtualenv .venv --python python 3; . .venv/bin/activate ; pip install -r requirements.txt` +2. Start `rt2zammad.py`, it will display template for configuration file. +3. Fill in the template and save it as `rt2zammad.json`. +4. Start `rt2zammad.py` to perform the migration. +5. Verify the migration results. +6. In case you need to roll back Zammad, please follow https://community.zammad.org/t/reset-database-to-start-from-zero/326