Migrating to a New Server (Docker)
This document is intended for users moving their Docker deployment from one server to another.
Steps
This guide uses our built-in backup and restore functionality. Larger installation, may find it faster, to use other technologies to migrate their data.
Migrate from the old server to the new server
Perform these steps on your old server:
- Visit Settings in the operator panel and enable the "Maintenance Mode" option.
- Disable the Cron Job.
-
Create a backup of your help desk.
Please use the--online
option. This ensures that background services are not restarted after the backup has completed. -
Copy the backup file to your new server. One way to do this is via the
scp
Linux command. The below command is an example, placeholders (capitalised), and paths should be replaced for actual usage depending on your scenario:scp /home/user/backup/APP.TAR.GZ USER@IP.IP.IP.IP:/home/user/backup/APP.TAR.GZ
Login to the new server, and follow the below steps:
-
Browse to the parent directory of the
backup/app.tar.gz
file that was created earlier, and restore the backup.Make a note of the database credentials shown in the output for future reference as they may be lost in the output of the restore script.It is normal for this process to take a number of hours to run. Depending on the size of your database, it could well be hours or days.Whilst not strictly necessary, we recommend to run the restore process as the root MySQL user. If you, or a plugin, have modified the default database in any way then sometimes root access is required to fully import the database backup. It is preferable to use root, to avoid the restore crashing after a number of hours due to a permissions issue. - Login to the SupportPal client area and re-issue your license so that it is unlocked.
- Login to the operator panel.
- Visit Settings and disable the "Maintenance Mode" option.
- If your SupportPal URL has changed you will also update your brand URL (Settings > General > Brands > Website (tab) and update the System URL option).
-
Enable the SupportPal cron job.
Verify the tasks are running by visiting Settings -> Core -> Scheduled Tasks and refreshing every few minutes. -
If you restored using root database credentials, please revert back to the
supportpal
user credentials by manually updatingconfig/production/database.php
within the container.