fnux/rt2zammad
1
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity

Cleanup README

Browse source
This commit is contained in:
fnux 2024-04-19 14:05:24 +02:00
parent b44e8eb96a
commit ee9cc01db8
No known key found for this signature in database
GPG key ID: 4502C902C00A1E12
1 changed files with 2 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,34 +1,5 @@
# rt2zammad # rt2zammad
Request tracker to Zammad migration script. This is not an out of box solution Request tracker to Zammad migration script, forked form [weblate's rt2zammad](https://github.com/nijel/rt2zammad).
for everybody, you will probably have to customize it.
## Known issues **Quick setup:** `virtualenv .venv --python python3; . .venv/bin/activate ; pip install -r requirements.txt`
* 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.
## 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
0. Review the script code, most likely it will not work out of box for you.
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
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.