Installation

Purchase

Purchase the module from CodeCanyon.net.

Requirements

  • Perfex CRM 3.1.0 or higher (requires PHP 8.1+, MySQL 5.7+/8.0+ or MariaDB 10.3+)
  • PHP extensions: openssl, curl, json, mbstring, pdo_mysql, zip, zlib
  • Write permissions on the uploads/ directory
  • SaaS tenant migrations require the Perfex SaaS module installed on both installations (standalone installations do not need it)

Upload and activate the module

  1. Extract your downloaded file content. You will notice a folder called "documentation" and a zip file, called "instance_migrator.zip". Since the "documentation" folder contains this readme file and helpful instructions that are not needed in your Perfex CRM's installation, we will focus on the "instance_migrator.zip" file.

  2. "instance_migrator.zip" contains the module files (in a module format) that you can upload in Perfex CRM's Modules installation section.

  3. Go to your Perfex CRM's Admin area and select the following menu item: SETUP > MODULES.

  4. Select the extracted instance_migrator.zip at the Module installation selection prompt and press INSTALL.

  5. Find the newly installed module and press ACTIVATE.

  6. You will be told that the module is successfully activated.

  7. You can now see "Migration Tools" under SETUP and access its Dashboard, Server Connections, Export Data, Import Data, and Migration History pages.

Migration Tools menu

Removing the module after migration

Instance Migrator is a migration tool, not a permanent part of the application. Once the migration is complete — or whenever the module is no longer needed — remove it from your installation on both the source and the destination servers.

Warning: As secure as the transfer flow is, a migration tool is unnecessary attack surface on a live site. Do not leave the module installed and activated once its job is done.

To remove it:

  1. Go to SETUP > MODULES and locate Instance Migrator.
  2. Choose one of:
    • DEACTIVATE - Stops the module but keeps all of its data (migration history, server pairings, export packages, keys). Use this if you still need the records or may migrate again.
    • UNINSTALL - Removes the module's tables and settings entirely (migration history, pairings, connection secrets, and token options are deleted). Exported packages already downloaded to disk are not deleted.
  3. Before uninstalling, download from Migration History anything you want to keep (SQL dump, media archive, and the encryption key) — the records are wiped by uninstall.

Keep to this pattern: migrate, verify the destination, then remove the module.