Installing the Deployment Framework

This page provides instructions on how to install the Caplin Deployment Framework, which you can then use to deploy Liberator, Transformer, and integration adapters.


Operating system

The Deployment Framework 8 is supported on the following operating systems:

  • Red Hat Enterprise Linux 9 (x86_64, aarch64) [recommended]

  • Red Hat Enterprise Linux 8 (x86_64)

  • Red Hat Enterprise Linux 7 (x86_64)

Operating system packages

The Deployment Framework 8 requires the following Red Hat packages:

  • zip

  • unzip

  • procps-ng

  • which


By default, the Deployment Framework uses the JVM set by the environment variable JAVA_HOME to run any Caplin Platform component or module that requires Java. You can specify a different JVM by using the Deployment Framework CLI’s java command (see below). Only one JVM can be specified in the Deployment Framework; you cannot specify a separate JVM for each component deployed in the framework.

Installing the Deployment Framework

Follow the steps below to install the Deployment Framework:

  1. Open a Bash terminal.

  2. Copy the Deployment Framework installation kit (DeploymentFramework-<version>.zip) to the directory you want to install to.

  3. Extract the Deployment Framework installation kit using the unzip command with the -o (overwrite), -a (convert line-endings), and -q (quiet) flags:

    unzip -qoa DeploymentFramework-<version>.zip
  4. Change directory to the root directory of the Deployment Framework:

    cd DeploymentFramework-<version>
  5. [optional] If you want to specify a different JVM to that specified by the environment variable JAVA_HOME, run the Deployment Framework CLI’s java command to specify the full path to a JVM library:

    Red Hat Enterprise Linux (OpenJDK 17)
    ./dfw java "/etc/alternatives/java_sdk_17/lib/server/"

    For guidance on JRE compatibility with Caplin Platform components, see Caplin Platform System Requirements.

  6. [optional] Enable Bash auto-completion for the dfw command. See Setting up dfw command completion.

    This step sets an environment variable that is required for the correct operation of the logcat command

See also: