rt2zammad/README.md

35 lines
1.7 KiB
Markdown
Raw Normal View History

2019-05-25 08:07:42 +00:00
# rt2zammad
Request tracker to Zammad migration script. This is not an out of box solution
for everybody, you will probably have to customize it.
2020-12-30 08:45:47 +00:00
## 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.
* Timestamps are not preserved. The Zammad API doesn't seem to allow this.
* Zammad will send notification for all actions, you probably want to disable
outgoing mail for time of import:
* Disable all triggers sending mail (Manage / Trigger
* Disable notifications for all existing users (seems like every user has to do this)
* Safer approach might be to use own SMTP server and temporarily discard all
mail from Zammad for the migration run.
2020-12-30 08:41:31 +00:00
2020-12-30 08:45:47 +00:00
## Maintenance status
2020-12-30 08:41:31 +00:00
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.
2020-12-30 08:45:47 +00:00
## Usage
2020-12-30 13:06:20 +00:00
0. Review the script code, most likely it will not work out of box for you.
2020-12-30 08:45:47 +00:00
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
2020-12-30 08:47:15 +00:00
Note: The RT content is cached in `rt2zammad.cache`. In case the RT is still receiving updates, you might want to delete the file for consequent runs.