Backup, Restore, and Migration Guide for Exploratory Server

Data to Back Up

To ensure data integrity and recovery, back up the following 3 directories and 1 file located under the Exploratory Server installation directory:

Directories

  • data: Contains MongoDB data for user accounts and metadata required by Exploratory Server.
  • users: Stores published content such as Dashboards, Notes, and Charts.
  • rdata: Contains parameter data files.

File

  • docker-compose.yml: The server configuration file defining services, networks, and volumes.

Backup Procedure

Follow these steps to create a backup:

  1. Shutdown the Collaboration Server:

    • Ensure the Exploratory Server is not running. Use the appropriate shutdown command or follow the official documentation for stopping the server.
  2. Copy the Data:

    • Backup the data, users, and rdata directories, along with the docker-compose.yml file, to a secure storage location.

Restore Procedure

To restore data from a backup:

  1. Shutdown the Exploratory Server:

    • Ensure the server is completely stopped before proceeding.
  2. Replace Files and Directories:

    • Replace the data, users, and rdata directories and the docker-compose.yml file in the installation directory with their respective backup copies.
  3. Restart the Server:

    • Start the Exploratory Server and verify its functionality. Ensure user accounts, metadata, and published content are restored correctly.

Migration Procedure

To migrate an Exploratory Server installation from one machine to another, follow these steps:

  1. Create a Backup:

    • Follow the backup procedure on the original server.
  2. Prepare the Destination Server:

    • Expand the Exploratory Server distribution file on the destination machine.
    • Modify the exploratory_config.yml file in the exploratory directory to match the new server’s environment. Refer to the Installation Guide for details.
    • Run the configure.sh script located in the exploratory directory to set up the new server environment.
  3. Transfer Backup Data:

    • Copy the backed-up data, users, and rdata directories, along with the docker-compose.yml file, to the appropriate locations on the destination server.
  4. Update Hostname (if applicable):

    • If the original and destination servers have different hostnames, update the docker-compose.yml file to reflect the new hostname.
  5. Start the Destination Server:

    • Start the Exploratory Server on the destination machine.
  6. Verify Migration:

    • Confirm that all user accounts, metadata, and published content are intact and match the original server.
Export Chart Image
Output Format
PNG SVG
Background
Set background transparent
Size
Width (Pixel)
Height (Pixel)
Pixel Ratio