Installation Instructions

Installing CopyStorm (Windows)

Installing CopyStorm takes a few seconds and does not touch any system files or registry values. You should not need an administrator.

  • Make sure your computer meets the prerequisites.

    • All required software is packaged in the download as long as a Win32 or Win64 version of the application is selected.

  • Create the directory “C:\Capstorm”

  • Unzip the downloaded zip file into the “C:\Capstorm” directory. A single directory named CopyStorm will be created.

  • Create the directory “C:\Capstorm\CopystormConfig”.

  • Copy the CapstormCustomerKey.txt file into the “C:\Capstorm\CopystormConfig” folder.

    • Click here for more information about the CapstormCustomerKey.txt file.

  • Go to the “C:\Capstorm\CopyStorm” directory and:

    • Double click on CopyStorm.bat

Installing CopyStorm (Linux/Mac)

Installing CopyStorm takes a few seconds and does not touch any system files. You should not need root permissions.

  • Make sure your computer meets the prerequisites.

    • Java 11 (or above) must be installed.

  • Create the directory “/opt/capstorm”

  • Unzip the downloaded zip file into the “/opt/capstorm” directory. A single directory named CopyStorm will be created.

  • Create the directory “/opt/capstorm/CopystormConfig”.

  • Copy the CapstormCustomerKey.txt file into the “/opt/capstorm/CopystormConfig” folder.

    • Click here for more information about the CapstormCustomerKey.txt file.

  • Go to the “/opt/capstorm/CopyStorm” directory and:

    • Run the command “sh CopyStorm.sh” (or make the launch script executable).

Installing CopyStorm (Docker)

CopyStorm can be installed in a Docker container by following instructions available here:

After creating the image and starting the container, it will run CopyStorm — backing up Salesforce to the configured relational database. When the backup finishes (successfully or with an error) the container will terminate.

Salesforce Requirements

  • The API package must be enabled.

    • Enterprise, Unlimited, and Developer Editions have this feature enabled by default.

  • A Salesforce login that can read data and data setup information.

CopyStorm Requirements

CopyStorm is supported on:

  • Windows

  • Linux:

    • RHEL, SUSE, Ubuntu

  • MacOS

  • VMWare hosted Windows, Linux, or MacOS

CopyStorm requires a Java 11 JRE or higher. Downloads indicating Windows 32bit or 64bit include the Java JRE, other systems require that a JRE be installed.

Runtime requirements for the CopyStorm application can vary between installs – if the installation will only run one CopyStorm job at a time, a good starting point is:

  • 1 CPU

  • 2 GB RAM

  • 10 GB of free disk space

    • CopyStorm stores large objects (e.g. Attachments) on-disk while copying to minimize RAM usage.

  • A graphics head that can be used to run the CopyStorm configuration UI

    • On linux, X11 forwarding can work but is known to be extremely sluggish.

    • A desktop environment that can be remotely accessed gives the best performance.

Last updated

Was this helpful?