Last updated on May 08, 2018

Migrating Appspace on-premises from Windows 2008 to Windows 2012 with easy migration tool

This article provides the instructions for you to easily migrate your Appspace server running on a Windows 2008 operating system to a new server with Windows 2012, using our built-in migration tool.

  1. Back up and create a recovery file
  2. Install Appspace and restore files
  3. Activate Appspace


This tool is only applicable for new installations of Appspace, and not upgrades. However, you may also use the tool when archiving or restoring Appspace data between server instances (e.g. transitioning between different server machines).


  • Appspace 5.2.3 and above.
  • Ensure your Windows 2008 server has been updated with the latest Microsoft updates.
  • A new server preinstalled with Windows 2012 R2 and updated with the latest Microsoft updates.
  • Administrator privileges for Windows Server 2008 and Windows Server 2012.
  • Administrator privileges for the Appspace account.
  • Identical license key(s) for the backup server.
  • Contact Appspace Support to obtain the latest version of the Appspace Installer, and the Appspace Migration tool.


  • All devices must be re-registered on the new server after the migration.
  • SSO settings will not be copied over to the new server after the migration.
  • Users whose invitations are pending must be deleted on the existing server, and re-invited again on the new server after migration.

Back up and create a recovery file


If you are using MS SQL, before proceeding with the steps below, please change the SQL Server (MSSQLSERVER or SQLSERVER) permission to Local System Account from the Services window, to provide the installer with access to the file path.

This is due to a known Microsoft issue where the system permission is lower than the MS SQL permission level.


This migration tool does not support the backup and recovery of a MS SQL database located on a remote server.

  1. On the Windows Server 2008, double-click and install the Appspace Migration tool.

  2. If your SQL server database is located on the same server as Appspace, follow the instructions below. If the SQL database is on a remote server, proceed to Step 3.

    • MySQL

      1. Launch the MySQL Workbench, and insert the below query:

        SHOW VARIABLES WHERE Variable_Name = 'basedir';
      2. Navigate to the path shown in the result. Example: C:\Program Files\MySQL\MySQL Server 5.6

      3. Double-click the ‘bin’ folder, and copy the ‘mysqldump.exe’ file.

      4. Paste the ‘mysqldump.exe’ file to the “C:\Appspace\Content\Tools\MySqlBin” folder.

    • MS SQL

      1. Go to Windows Control Panel > Administrative Tools, and launch the Services console.

      2. Locate and right-click the ‘SQL Server (MSSQLSERVER)’ service, and select ‘Properties’.

      3. Click the ‘Log On’ tab, and select ‘Local System account’.

  3. Launch the command prompt in Administrator mode, and enter the following command to switch to the Appspace migration tool directory:

    cd c:\program files (x86)\Appspace\Appspace CLI
  4. Run the tool and create a recovery file with the following commands:

    • If the SQL server is located within the same server:

      appspace recovery --db-engine=mysql --db-username=<username> --db-password=<password> --db-host=<localhost>
      --output-file=<file path>


      appspace recovery --db-engine=mysql --db-username=root --db-password=g56*k9lp --db-host=localhost
    • If the SQL server is located on another server, skip the database backup:

      appspace recovery --skip-backup-db --db-engine=mysql --db-username=<username> --db-password=<password>
      --db-host=<server ip> --output-file=<file path>


      appspace recovery --skip-backup-db --db-engine=mysql --db-username=root --db-password=g56*k9lp
      --db-host= --output-file=C:\temp

      Parameter Value description
      appspace This is the executable file
      recovery Option to start the recovery mode
      –db-username Database user name
      –db-password Database password

      Database server.

      • Use ‘localhost’ for local database.
      • Define the IP address for remote database.
      • Use ‘mysql’ for MySQL.
      • Use ‘mssql’ for SQL Server.
      –output-file Folder path to generate the recovery file.
      –skip=backup-db Option to skip the database backup, for remote database.
  5. Once the migration process completes, the recovery file containing the following files will be created:

    • appspace.sql - the database backup file
    • appspace.config - the Appspace configuration backup file
    • manifest.json - the latest media file IDs (mediaID, userGroupID, AppspaceVersion)

  6. Navigate to the output folder determined in Step 4 (C:Temp), copy the recovery file, and paste it to any location on the new Windows Server 2012 machine.

  7. Copy the Appspace content folder (C:\Appspace\Content\), and paste it to any location on the new Windows Server 2012 machine.

  8. On the current Windows Server 2008 machine, restart the IIS service and agents stopped during the migration process.

Install Appspace and restore files

  1. Install Apspspace 6.2.x on your new Windows 2012 server. Please refer to the Installing Appspace on-premises article.

  2. In Step 4 of the Install Appspace section, click Install.

  3. In Step 5 of the Install Appspace section, make the following edits in the Customizing Appspace window:

    • Content Folder - Browse and select the Appspace Content folder pasted in Step 7 above.

    • Recovery File - Check the ‘Restore from an existing Appspace recovery file’ option, browse and select the recently copied recovery file.

  4. Continue with Step 6 in the Install Appspace section.

Activate Appspace

Proceed to activate the new license. Please refer to the Activating Appspace on-premises article.