Skip to main content

Manual Export

in Basic Guides
Authors list
Published: Jan 5, 2023|Last updated: Jan 5, 2023
Warning

This method is for experienced System Administrators, who are comfortable with running commands via Command Prompt / Terminal

Note

If you are performing a production migration of your helpdesk, we recommend disabling your Deskpro v5 helpdesk before continuing with this guide.

This can be done in Admin > Setup > Settings by checking the Disable the helpdesk box, and clicking Save

Note

The guides below require the MySQL root password to export your database from your Deskpro v5 server. If you do not have your MySQL root password, you can use the credentials Deskpro uses to access the database.

These can be found in <deskpro_install_dir>/config/config.database.php.

Exporting your data from a Linux server Copy link to Exporting your data from a Linux server to clipboard

Logging in to your serverCopy link to Logging in to your server to clipboard

In order to run the commands listed below, you will need to login to your server via SSH.

If you use Windows for your desktop operating system, this can be done through the use of a program called PuTTY. You may also need a method to download the files from your server once generated. These can be done through either WinSCP using SCP, or Filezilla using SFTP

If you are a Mac or Linux user, you can use SSH or SCP directly through your Terminal.

Exporting the DatabaseCopy link to Exporting the Database to clipboard

From the CLI, run the following command to export your database to a .sql Export file:

mysqldump -u{user} -p {database_name} > /path/to/export.sql
copy

This command performs a MySQL Dump, which exports your database in SQL, and writes the output to a .sql file. You will need to replace the following variables in the above command:

  • {user} - This would either be root, or the user that Deskpro uses to access the database

  • {database_name} - The name of your Deskpro database.

  • /path/to/export.sql - The location where you want to write the .sql file.

The command will prompt you for the user's password before continuing, and your server may not respond until the export has completed.

Archiving the AttachmentsCopy link to Archiving the Attachments to clipboard

If you use Filesystem as your attachment storage mechanism, they are by default stored in the /attachments/ directory within your Deskpro installation directory. The command below should archive the entire attachments directory

zip /path/to/attachments.zip -rdc /path/to/deskpro/attachments
copy
Note

If the above command does not work, you may need to install the zip package through your Package Manager

You will need to replace the following variables in the command:

  • /path/to/attachments.zip - This is the location of the file you wish to write.

  • /path/to/deskpro/attachments - This is the location of your attachments directory.

Exporting your data from a Windows server Copy link to Exporting your data from a Windows server to clipboard

Logging into your serverCopy link to Logging into your server to clipboard

In order to run the commands below, you will need to login to your server via RDP.

If you use Windows or Mac, this is possible through the Remote Desktop app. Linux users can use an app called Remmina

We recommend mounting a local drive via RDP to download any files generated using this process.

Exporting the DatabaseCopy link to Exporting the Database to clipboard

From Command Prompt, find the MySQL installation directory, then enter the bin directory

cd C:\DeskPRO\MySQL\bin
copy

You can then run the following command to export your database to a .sql Export file:

.\mysqldump.exe -u{user} -p {database_name} > /path/to/export.sql
copy

This command performs a MySQL Dump, which exports your database in SQL, and writes the output to a .sql file. You will need to replace the following variables in the above command:

  • {user} - This would either be root, or the user that Deskpro uses to access the database

  • {database_name} - The name of your Deskpro database.

  • /path/to/export.sql - The location where you want to write the .sql file.

The command will prompt you for the user's password before continuing, and Command Prompt may not respond until the export has completed.

Archiving the AttachmentsCopy link to Archiving the Attachments to clipboard

Within Windows Explorer, open the Deskpro installation directory, Right Click on the attachments directory and select Send to > Compressed (zipped) folder image.png

This will create an attachments.zip file containing your files within the same folder.

Importing your data into the OPC Copy link to Importing your data into the OPC to clipboard

You can find the OPC webGUI by going to https://<opc_IP_address>:29443 or your OPC domain in your browser. image.png

  1. Login to the webGUI with your master password, or by generating a PIN with the following command on the OPC server command line:

sudo opc session
copy
  1. Click New under Instances in the side menu, then select the Import Instance option.

  2. If you want to perform a test import, click the Test option. Otherwise, if you are performing a live migration, select the Production option.

Warning

Test Instances cannot be converted to Live Instances, and must be deleted then re-imported under the Production option

To login to a test instance, you must append .test to your email address. If you use an external authentication method, you can login using a login token:

opc inst -i {instanceID} login-token {email_address}.test
copy
  1. Select Version 5 as the import source, then confirm that all steps have been completed and click Continue.

  2. Select Provide Export, then in the Import Instance window, select the Database option under Import File. Upload your .sql Export file under Database and your .zip Attachments file under Attachments, and wait for the files to finish uploading. image.png

  3. OPTIONAL If you wish to use an external MySQL database or an external ElasticSearch server, you can configure them here.

  4. Click Import Instance to start the import process. Once complete, click Continue to view the instance page..

Final Steps Copy link to Final Steps to clipboard

Once you have completed the migration, please follow the final steps to open your new helpdesk.

HelpfulUnhelpful
next pageWindows in-situ update
previous pagedputils Method

Please log in or register to submit a comment.