Let the platform do the work

Migrating From a Broken Instance to a Clean Install

Overview

The following article describes the process of migrating a potentially broken instance to a clean install.

This is beneficial in the use case of corrupted core files. This will not correct issues caused by broken customizations.

Requirements

To migrate your instance to a clean install you will need to do the following:

  • Have full permissions to modify the system files.
  • Identify your Sugar version. 
    Note: The version of your instance can be found by clicking the Help link in Sugar's footer or navigating to the About page from your user menu. 
  • Once you have identified your Sugar version, you will need to download the full installer package of your Sugar version from your account's Downloads page.
  • If you are on 14.0.0 Pro, you must download the SugarPro-14.0.0.zip package or the migration will not work.

Migrating to a New Instance

  1. Make a complete backup of your broken instance. This includes both the filesystem and database.
  2. Extract the contents of your downloaded Sugar package ( Sugar<Edition>-<Version>.zip ) to your web directory. This will be your clean Sugar directory that we will migrate your existing instance to.
  3. You will then need to copy the following directories and files from your broken instance to the clean instance:
    • ./config.php
    • ./config_override.php (if it exists)
    • ./custom/
    • ./upload/
    • ./cache/images/ - This is optional and contains the embedded emails displayed in the UI.
    • Note: If you are on a version prior to 6.4.0, you will also need to copy over the entire ./cache/ directory.
  4. Next, you will need to identify if you have any custom modules. These folders will reside in your ./modules/ directory and have a naming format of <key>_<module name>. You will need to copy these files to their corresponding directory in the clean instance you extracted in step 2.
  5. Once the files have been moved to the clean instance, you can remove your old instances files and move the clean instance in its place. If you choose to move the instance to a new location on the server, you will need to update the $sugar_config['site_url'] parameter in your ./config.php and/or ./config_override.php files.
  6. Reset your filesystem permissions.
  7. Log into your instance as an administrator and navigate to Admin > Repair > Quick Repair and Rebuild.