Installing Liberator

This page tells you how to install an instance of Liberator, using the Caplin Deployment Framework.

For instructions on upgrading an existing installation of Liberator, see Upgrading Liberator.

Contents:

Requirements

Liberator 6.2 must be deployed on the Deployment Framework 6.2.

Liberator 7 must be deployed on the Deployment Framework 7.

For server hardware and software specifications, see Caplin Platform System Requirements.

The Microsoft Windows build of Liberator 7 requires the Microsoft Visual C++ 2015 Redistributable.

Note: the Microsoft Windows build of Liberator is not supported for use in production environments.

Installation instructions

If you are upgrading an existing installation of Liberator, see Upgrading Liberator.

Tip: In the following steps you'll be using the dfw command of the Deployment Framework. Before entering any dfw command as ./dfw <command-name>, make sure your current (working) directory is set to the Deployment Framework's topmost directory. For a list of dfw commands, click here.

Follow the instructions below to install Liberator:

  1. Install the Deployment Framework
  2. Stop all components running under the Deployment Framework
  3. Install your Liberator's licence file
  4. Install the public key from your KeyMaster installation
  5. Deploy Liberator
  6. Confirm deployment
  7. Start the Liberator
  8. Test your installation
  9. Secure Liberator for use in production

1. Install the Deployment Framework

If you have already installed the Deployment Framework, you may skip this step.

To install the Deployment Framework, follow the instructions in Installing the Deployment Framework.

2. Stop all running Caplin Platform components

If you installed the Deployment Framework in step 1, you may skip this step.

It is important that all Caplin Platform components are stopped before installing new components or making configuration changes.

To stop all Caplin Platform components running under the Deployment Framework, type the command below:

./dfw stop

3. Install the Liberator licence file

If you have a licence for this Liberator, copy the licence file (license-rttpd.conf) to the Deployment Framework's licence directory: <Framework-root>/global_config/licenses

If you don't have a licence file, then, on deployment of Liberator (step 5), the Deployment Framework will copy Liberator's evaluation licence to the licence directory: <Framework-root>/global_config/licenses. The evaluation licence allows Liberator to run for 30 minutes, after which time Liberator will automatically shutdown. To use Liberator for production or development use, contact Caplin Support for an authorised licence.

Tip: You only need to copy Liberator licences to the server machines on which your licenced Liberators run.

4. Install the KeyMaster public key

If you are not using Caplin's KeyMaster to provide single sign-on (SSO) between your web application server and Liberator, you may skip this step.

The Deployment Framework directory <Framework-root>/global_config/ssl includes a copy of KeyMaster's default public key, keymaster_public.der. This key is not supported for use in production, and it is normal practice to generate a new key-pair during the installation of KeyMaster.

To overwrite <Framework-root>/global_config/ssl/keymaster_public.der with the public key from your KeyMaster installation, follow the instructions below:

  1. If you have not already done so, generate your own key-pair for KeyMaster. See Installing KeyMaster.
  2. Overwrite the file <Framework-root>/global_config/ssl/keymaster_public.der with the public key from your KeyMaster installation.
    1. Note: Liberator expects the KeyMaster public key file to be DER encoded and to have the file name keymaster_public.key

5. Deploy Liberator

To deploy Liberator:

  1. Copy the Liberator installation file into the <Framework-root>/kits directory
  2. Issue the command below to deploy Liberator:
    1. ./dfw deploy
    2. Note: If this command writes one or more warning messages of the format "Not copying override file..." to the console, then you are upgrading an existing installation of Liberator. See Upgrading Liberator.

The ./dfw deploy command performs the following tasks:

  1. Unpacks Liberator
  2. If no Liberator licence is found in <Framework-root>/global_config/licenses directory, copies Liberator's evaluation licence to the directory.
  3. If no override files for Liberator are found in <Framework-root>/global_config/overrides/servers/Liberator directory, copies Liberator's override files to the directory.
  4. If this is the first deployment of Liberator to this Framework, activates a minimal set of built-in blades: DirectConnection, HTTP, LiberatorWebsite, and ServerIdentification.
  5. Moves the Liberator installation file into the <Framework-root>/kits/archive/ directory.
    1. Note: the installation file is moved to the archive directory regardless of whether the blade installed successfully.

6. Confirm deployment

To confirm that Liberator has deployed correctly, issue the command below:

./dfw versions

Example output:

Deployment Framework           7.0.1-307258

Core components                Version
-----------------------------------------------------------
Liberator                      7.0.1-307324

Deployed blades                Version            State
-----------------------------------------------------------
BlotterExport                  7.0.1-307324       Inactive
CfgPermissioning               7.0.1-307324       Inactive
DirectConnection               7.0.1-307324       Active
DirectSSLConnection            7.0.1-307324       Inactive
HTTP                           7.0.1-307324       Active
HTTPS                          7.0.1-307324       Inactive
JavaOpenPermissioning          7.0.1-307324       Inactive
LiberatorDemoDataSource        7.0.1-307324       Inactive
LiberatorJMX                   7.0.1-307324       Inactive
LiberatorWebsite               7.0.1-307324       Active
MinimalLiberatorWebsite        7.0.1-307324       Inactive
OpenPermissioning              7.0.1-307324       Active
ServerIdentification           7.0.1-307324       Active
TokenPermissioning             7.0.1-307324       Inactive
XMLPermissioning               7.0.1-307324       Inactive

7. Start Liberator

To start Liberator and all other components installed on the Deployment Framework, enter the command below:

./dfw start 

8. Test your Liberator installation

This section lists ways to test that your installation of Liberator was successful.

Check Liberator is running

To view the current status of Liberator, enter the command below:

./dfw status

Example output:

Core components                Status             Process ID
------------------------------------------------------------
Liberator                      Running            3190

View Liberator's status web page

To view Liberator's status web page:

  1. Discover the port number of Liberator's web interface by executing the Deployment Framework command: ./dfw info
  2. Open a web browser and navigate to http://<url_of_liberator_server>:<liberator_port_number>
    1. If Liberator is running correctly, you should now see the home page for the Liberator.
  3. On the Liberator home page, click Status.
  4. Enter the default authentication credentials: username = "admin", password = "admin"
Warning: Liberator's default web interface is not supported for use in production environments. See Secure Liberator for use in production.

For more information on the Liberator status web page, see Liberator status web page.

Stream example data

Liberator includes a built-in blade that provides example price streams.

To activate the blade, follow the instructions below:

  1. Stop all components installed on the Deployment Framework:
    1. ./dfw stop
  2. Activate the LiberatorDemoDataSource blade:
    1. ./dfw activate LiberatorDemoDataSource
  3. Restart all components installed on the Deployment Framework:
    1. ./dfw start

To view the example price streams in Liberator's web interface:

  1. Discover the port number of Liberator's web interface by executing the Deployment Framework command: ./dfw info
  2. Open a web browser and navigate to http://<url_of_liberator_server>:<liberator_port_number>. The Liberator home page should appear.
  3. On the Liberator home page, click Diagnostics.
  4. On the Liberator Diagnostics page, click Liberator Explorer - Stable.
    1. If you are asked to login, use the following credentials: username=admin, password=admin
    2. By default, Liberator Explorer connects to Liberator over an unsecure connection. If you have deactivated Liberator's HTTP blade and activated the HTTPS blade, then Liberator Explorer will fail to connect. To configure Liberator Explorer to connect over a secure connection, click to open the configuration dialog, and then change Liberator Explorer's connection protocol to 'rttps'.
  5. In the Container field, type the text below and press Enter
    1. /EXAMPLES/PRICING/CONTAINERS/EQUITIES

9. Secure Liberator for use in production

Make the following changes to secure Liberator for use in production:

  1. Deactivate the HTTP blade and activate the HTTPS blade. See Configure how Liberator handles HTTPS connections.
  2. Deactivate the OpenPermissioning blade and activate a permissioning blade that has a stricter security policy. See User authentication and permissioning.
  3. Deactivate the LiberatorWebsite blade, and activate the MinimalLiberatorWebsite blade.
    1. ./dfw stop
    2. ./dfw deactivate LiberatorWebsite
    3. ./dfw activate MinimalLiberatorWebsite
    4. ./dfw start

For more information about securing Caplin products, see:


See also: