/
Method 3: Snapshot Migration

Method 3: Snapshot Migration

Overview

The snapshot-based migration method is a side-by-side approach that provides a way to move Voyager data and configurations from an existing environment to a new HQ 2.0 and Voyager Server 3.0 deployment. By creating and restoring a system snapshot, administrators can capture the current state of repositories, pipelines, and configuration settings—including search indexes and metadata—and apply them directly to the new server instance.

When to Use This Method

The snapshot migration method is best suited for test, development, or temporary environments where speed and simplicity are prioritized. This approach minimizes manual setup, ensures consistency across environments, and is ideal for customers seeking to replicate or upgrade production systems with minimal downtime. However, because some configuration settings may not be fully preserved, this method requires post-migration validation to ensure data integrity and system accuracy.

Preparing for Migration

Step 1: Install Voyager Server 3.0

Go to the Voyager download page and run the installer for Voyager Server 3.0 into a new directory on your machine. A new voyager/server_3.0 directory will be created when the installation is complete. 

 

Step 2: Install HQ 2.0

Go to the Voyager download page and run the installer for HQ 2.0 into a new directory on your machine. A new Voyager/HQ directory will be created when the installation is complete.

Step 3: Copy Configurations for Voyager HQ and Server

HQ

  1. Go to your HQ 1.X home directory, copy the /config folder — and optionally the /py and /logs folder. Transfer these folders into your HQ 2.0 home directory.

  2. Make a copy of the hq VMOPTIONS File in the HQ folder within your HQ 1.X directory. Open the copied file and under the DIRECTORIES section, add the VM option similar to the one below:

-Dhome.dir=D:\voyager\hq-home-2.0

IMPORTANT: Ensure that the VM option above corresponds to the correct file path in your HQ 2.0 install directory.

  1. Then, move this hq VMOPTIONS File to the HQ installation directory.

Server

  1. Go to the Server 2.X data directory, copy the /config folder — and optionally the /logs and /meta folders. Transfer these folders into your Server 3.0 data directory.

  2. Make a copy of the Voyager VMOPTIONS File in the app folder within your Server 2.X directory. Open the copied file and under the #Directory section, add the VM option similar to the one below:

-Ddata.dir=D:\voyager\server-data-3.0

IMPORTANT: Ensure that the VM option above corresponds to the correct file path in your Voyager Server 3.0 install directory.

  1. Then, move this Voyager VMOPTIONS File to the Server-3.0 app directory.

NOTE: The /meta folder can take a significant amount of time to copy over to the new directory. If you would like to migrate this file then it is recommended to move the file instead of copying it over.

Step 4: Temporarily Redirect Ports for Voyager Server 3.0

For this migration method, both instances of Voyager Server have to be running in parallel to successfully migrate one version to another. Both instances will have the same ports by default which will cause conflicts if a new port isn’t set in the site.dex file in your Server 3.0 install directory.

  1. Using the table below, copy the specified files from the Voyager 2.X install directory and place them in the corresponding file paths within your Server 3.0 installation directory.

  2. After transferring the files, update the configuration settings for the Server 3.0 files listed in the table below. Ensure that the port values have been modified so they no longer match those used by Server 2.X. This step prevents conflicts between the old and new instances and ensures proper communication between Server 2.X and 3.0.

File

Path

Setting

Old Instance (Server 2.X)

New Instance (Server 3.0)

File

Path

Setting

Old Instance (Server 2.X)

New Instance (Server 3.0)

site.dex

voyager/server_X.X/data/config

Base URL

BaseURL=http\://YOURBASEURL\:8888/

BaseURL=http\://YOURBASEURL\:7777/

Voyager (VMOPTIONS File)

voyager/server_X.X/app

-Dport

-Dport=8888

-Dport=7777

Voyager (VMOPTIONS File)

voyager/server_X.X/app

-Dport.discovery

-Dport.discovery=8900

-Dport.discovery=7900

 

Step 5: Start Server 3.0

  1. Launch Server 3.0; it will auto-upgrade the configuration files and rebuild a new index. The locally stored index file within your /data directory will be located in the indexV3 folder.

  2. If needed, activate the new Server 3.0 instance using the license key that was issued to you.

 

Step 6: Start HQ 2.0

  1. Launch HQ 2.0; it will auto-upgrade the configuration files and rebuild a new index.

  2. If needed, activate the new Voyager HQ 2.0 instance using the license key that was issued to you.

IMPORTANT: Ensure that HQ 1.X and Server 2.X are fully shut down before proceeding. If these services remain active when launching Server 3.0 and HQ 2.0, then the applications will fail to start properly.

 

Step 7: Validate Functionality

In the new Voyager Server 3.0 instance, confirm that the settings and configurations are loaded correctly from Server 2.X. 

 

Step-by-Step Migration Guide:

Before migrating from HQ 1.X and Server 2.X to HQ 2.0 and Server 3.0, you should always create a backup Snapshot. Use Snapshots to save a copy of the index to disk and import the index later.

Steps:

  1. To use these tools in Manage UI, go to Manage -> Index -> Snapshots.

  2. Select Snapshots and then click Create Snapshot.

  1. Name the Snapshot and then check the following options shown in the image below.

NOTE: These items in the Snapshot, including your configurations, can then be migrated from Server 2.X to Server 3.0. The following options as shown in the image below can be selected for this release.

 

  1. When the available options have been selected then click Create New Snapshot.

  2. Once the Snapshot has been created, then go to Manage UI for the Server 3.0 and select Import Snapshot.

  3. Select the My Computer option and click Browse.

  1. Locate and select the generated snapshot file from Server 2.X installation directory. The snapshot file can be found at the following path:
    voyager/server_2.X/data/snapshot

  2. Once located, select Open to proceed with loading the snapshot into your Server 3.0 environment.

  3. Select Import Snapshot and the importing status will appear. A pop-up message in Server 3.0 will indicate when the importing process is completed.

  4. Navigate back to the Snapshots page with the list of your snapshots and under the Actions column, select the Apply icon.

 9. Ensure the desired settingss are selected and under Select An Action, switch Merge to Replace.

  1. Select Apply to proceed. You will be redirected to the Snapshot Status page, where you can monitor the progress of your snapshot as it is loaded into your Server 3.0 instance. Once the process is complete, your snapshot settings have been successfully migrated.

 

Quality check

In Navigo, preview the saved searches:

  • Select the Saved button located next to your Cart.

  • Check through the My Saved Searches, Suggested Searches and Recent Searches to ensure they have been properly migrated from the previous version.

  • Select from a few saved searches to confirm that the correct search parameters and results are showing.

 

Need Help?

If you have any questions about the migration process or regarding the HQ 2.0 and Voyager Server 3.0 release, please contact us at support@voyagersearch.com.