All pages
1 of 3

Loading...

Loading...

Loading...

Database Bootstrapping

The CapStorm/Container stores configuration and scheduling data in a CopyStorm/Director Database. The database is initialized when the CapStorm/Container first connects.

You can configure the database connection by either:

  1. Providing environment variables with connection information.

  2. Setting the connection information on the Initial Server Configuration tab.

After the connection information is provided, the container will alter the database to match by creating tables and columns as defined in the Director Database schema. All tables, including those denoted (Platform Only), are a part of the CopyStorm/Container backing database.

The Director Database should not include Salesforce records replicated through CopyStorm. Attempting to use a database previously built by the CopyStorm application will result in failures.

Installation Instructions

To install the CapStorm/Container, you will need to have a container host ready to run the container.

This installation guide provides an example installation path using the Docker Desktop application.

1: Launch the container

  1. Pull the latest image from the capstorm/capstorm docker repository.

  2. Configure port forwarding to enable web access. CapStorm/Container web services are hosted via Apache Tomcat, which consumes the following ports:

    1. Container port 8080 provides HTTP access.

    2. Container port 8443 provides self-signed HTTPS access.

  3. Start the container.

  4. Navigate to the container’s web URL ().

If the image has successfully launched, you will see a screen that looks like this:

Once the container is launched, log in with the following credentials:

  • Username: capstorm

  • Password: capstorm

To configure initial container parameters, click on the Click Here for Initial Configuration link:

After Clicking the Click Here for Initial Configuration link, you will see a screen that looks like this:

Parameter
Required
Description

When initialization parameters have been provided, click Validate Configuration to validate the provided customer key & database connection.

After a successful save you’ll see the following dialog:

Refer to the comprehensive for in-depth insights into various components of the web application.

Customer Key

yes

CapStorm-provided identifier, used for licensing.

Admin Password

yes

2: Provide Initialization Parameters

Initialization Parameters

3: Click Save Configuration & start using CapStorm!

http://localhost:8080
CapStorm/Container Reference documentation

The password for the “Admin” username. After initializing, the “CapStorm” user is no longer available and the “Admin” username will be used.

Third-party Authentication:

  • Salesforce Username

  • Authenticator URL

  • Client Id

  • Client Secret

no

Use these parameters to authenticate with the CapStorm/Portal using a Salesforce username and password.

Connection String

yes

JDBC Connection String used to connect to the CapStorm/Portal configuration database. For initial configuration, this should point to an empty schema – the CapStorm/Portal will bootstrap all required schema elements.

JDBC Driver

yes

JDBC driver used to connect to the CapStorm/Portal configuration database.

Username

yes

JDBC username used to connect to the CapStorm/Portal configuration database.

Password

yes

JDBC password used to connect to the CapStorm/Portal configuration database.

Installation via Docker Desktop

To install the CapStorm/Container, you will need to have a container host ready to run the container.

This installation guide provides an example installation path using the Docker Desktop application.

Note: To install the container using Docker Compose (CLI), please refer to CapStorm’s docker hub for an example.

Prerequisites

  • A Host For the Docker Container

  • A CapStorm Customer Key GUID

    • The CapStorm team will provide you with a unique Customer Key associated with your account. This key provides access to your entitled features. The CapStorm customer key will take the following form:

      • XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

  • Valid database connection details to a MySQL, PostgreSQL, or SQL Server database

    • The CapStorm Platform database user is expected to have the following Database Permissions

      • CONNECT

        • Used to establish remote connections to the target database

If your organization wishes to use Salesforce as an Authenticator for CapStorm/Container, be sure to follow our guide for

Pull the latest image from the docker repository

  • This can be accomplished by searching for the image in Docker Desktop and clicking Pull. Note that the latest GA release of the CapStorm/Container will have the tag latest.

  1. In Docker Desktop, navigate to Images

  2. Click the Play Icon to queue up the container launch

  3. Before clicking the Run button, expand optional settings. You’ll see the following screen:

    • Use this screen to provide:

Capstorm-platform environment variable
Description

After providing all previously mentioned environment variables, the image is ready to launch. Click the Run button to start the container.

The screenshot below is an example of an image launch:

Note: The container bootstrapping process is completed once you see the following message in the Container Logs:

CopyStormDirector is waiting for 0 jobs to complete.

Note: The following message will be displayed in the Container Logs if there are issues establishing a connection with the Database:

Exception in thread “main” java.lang.Exception: Cannot connect to database.

at com.capstorm.platform.configuration.webconfig.a.b(SourceFile:260) at com.capstorm.platform.environmentinitializer.EnvironmentInitializer.c(SourceFile:175) at com.capstorm.platform.environmentinitializer.EnvironmentInitializer.b(SourceFile:415) at com.capstorm.platform.environmentinitializer.EnvironmentInitializer.main(SourceFile:441)

Note: The following message will be displayed if there were any issues bootstrapping the CapStorm/Container:

Error running scheduled CopyStorm/Director jobs

  1. In a Web Browser, navigate to or

  2. You will see the following screen:

  3. If you did NOT provide initialization environment variables: log in with the temporary bootstrap credentials capstorm / capstorm, then click “Click Here for Initial Configuration” and complete the setup wizard (Customer Key, Admin Password, database connection, etc.).

Please refer to the Reference Documentation for the CapStorm/Container and core CapStorm Applications:

    • Backup Salesforce to a Relational Database

  • CREATE DATABASE

    • Used to provision databases containing Salesforce Backups

  • DROP DATABASE

    • Used to deprecate legacy Salesforce Backup databases

  • For the Salesforce Backup databases, The CapStorm Platform user is expected to have:

    • INSERT

    • DELETE

    • UPDATE

    • CREATE / ALTER TABLE privileges

      • Used to mirror & maintain changes in Salesforce data model

  • The database can be hosted in a container, or in any major RDBMS hosting platform (e.g. AWS, Azure, GCP, or on-premises)

    • A name for the container

    • Host port mappings for ports 8080and 8443

    • Environment Variables mentioned below

  • You can start the container with only port mappings (8080/8443). On first launch, the UI will allow initialization via the Initial Configuration setup page.

    • Temporary bootstrap login (before initialization):

      • Username: capstorm

      • Password: capstorm

  • Provide Environment Variables for Container Initialization

    • Note: Required Environment Variables are BOLDED.

    • Note: Required Salesforce Authenticator Environment Variables are ITALICIZED.

  • CUSTOMER_KEY

    CapStorm Customer Key. Provided by CapStorm team members.

    ADMIN_PASSWORD

    Default CapStorm/Container administrator password. This parameter can be used to initialize the password for the ‘admin’ user – if the admin user is already initialized this parameter has no effect.

    EXTERNAL_AUTHENTICATOR

    A name for the Salesforce OIDC External Authenticator – usually “Salesforce”.

    OIDC_ISSUER_URL

    Provide the complete URL of your Salesforce instance for user authentication.

    OIDC_ADMIN_USERNAME

    Provide the Salesforce username that will be granted administrator permissions for the CapStorm platform app.

    OIDC_CLIENT_ID

    CONSUMER_KEY value obtained in Prerequisite – Salesforce Authenticator step.

    OIDC_CLIENT_SECRET

    CONSUMER_SECRET value obtained in Prerequisite – Salesforce Authenticator step.

    If you DID provide initialization environment variables (including ADMIN_PASSWORD):
    log in as:
    1. Username: admin

    2. Password: Value of ADMIN_PASSWORD environment variable from Step (2)

  • Upon successful login, you’ll see the CapStorm/Container Web UI:

  • Schedule CopyStorm Jobs

  • CopyStorm/Medic Reference

    • Validate, Maintain, & Repair CopyStorm Databases

  • CopyStorm/Restore Reference

    • Push Data from a CopyStorm Database to Salesforce

  • DB_CONNECTION_STRING

    The connection string to the target database. This database will be used as the backing store for container configuration.

    DB_USERNAME

    The Database User for the CapStorm container database.

    DB_PASSWORD

    Prerequisites – Salesforce Authenticator

    1: Pull the latest image

    2: Launch the container

    3: Wait 5 minutes for the container initialization process.

    4: Navigate to the CapStorm/Container Web Application

    5: Start using the CapStorm Container!

    Setting Up Salesforce for Authentication
    capstorm/capstorm
    capstorm/capstorm
    https://localhost:8080
    http://localhost:8080/
    CapStorm/Container Reference
    CopyStorm Reference
    CopyStorm/Director Reference

    The Database Password for the CapStorm container database user.