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.
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.
|The Microsoft Windows build of Liberator is not supported for use in production environments.|
If you are upgrading an existing installation of Liberator, see Upgrading Liberator.
In the following steps you’ll be using the
Follow the instructions below to install Liberator:
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:
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.
|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.
<Framework-root>/global_config/ssl/keymaster_public.der with the public key from your KeyMaster installation, follow the instructions below:
If you have not already done so, generate your own key-pair for KeyMaster. See Installing KeyMaster.
Overwrite the file
<Framework-root>/global_config/ssl/keymaster_public.derwith the public key from your KeyMaster installation.
Liberator expects the KeyMaster public key file to be DER encoded and to have the file name
5. Deploy Liberator
To deploy Liberator:
Copy the Liberator installation file into the <Framework-root>/kits directory
Issue the command below to deploy Liberator:
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.
./dfw deploy command performs the following tasks:
If no Liberator licence is found in
<Framework-root>/global_config/licensesdirectory, copies Liberator’s evaluation licence to the directory.
If no override files for Liberator are found in
<Framework-root>/global_config/overrides/servers/Liberatordirectory, copies Liberator’s override files to the directory.
If this is the first deployment of Liberator to this Framework, activates a minimal set of built-in blades: DirectConnection, HTTP, LiberatorWebsite, and ServerIdentification.
Moves the Liberator installation file into the
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:
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:
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:
Core components Status Process ID ------------------------------------------------------------ Liberator Running 3190
View Liberator’s status web page
To view Liberator’s status web page:
Discover the port number of Liberator’s web interface by executing the Deployment Framework command:
Open a web browser and navigate to http://<url_of_liberator_server>:<liberator_port_number>
If Liberator is running correctly, you should now see the home page for the Liberator.
On the Liberator home page, click Status.
Enter the default authentication credentials: username = "admin", password = "admin"
|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:
Stop all components installed on the Deployment Framework:
Activate the LiberatorDemoDataSource blade:
./dfw activate LiberatorDemoDataSource
Restart all components installed on the Deployment Framework:
To view the example price streams in Liberator’s web interface:
Discover the port number of Liberator’s web interface by executing the Deployment Framework command: ./dfw info
Open a web browser and navigate to http://<url_of_liberator_server>:<liberator_port_number>. The Liberator home page should appear.
On the Liberator home page, click Diagnostics.
On the Liberator Diagnostics page, click Liberator Explorer - Stable.
If you are asked to login, use the following credentials: username=admin, password=admin
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'.
In the Container field, type the text below and press Enter
9. Secure Liberator for use in production
Make the following changes to secure Liberator for use in production:
Deactivate the HTTP blade and activate the HTTPS blade. See Configure how Liberator handles HTTPS connections.
The TLS certificate and private key that ship with Liberator in the
global_config/ssldirectory are provided as examples and should not be used in production.
Deactivate the OpenPermissioning blade and activate a permissioning blade that has a stricter security policy. See User authentication and permissioning.
Deactivate the LiberatorWebsite blade, and activate the MinimalLiberatorWebsite blade.
./dfw stop ./dfw deactivate LiberatorWebsite ./dfw activate MinimalLiberatorWebsite ./dfw start
For more information about securing Caplin Platform, see: