Guide

Installation

If you are part of the Early Adopter Program and wish to update your environment with this first production release of the Discngine LiveDesign Connector for Pipeline Pilot, please consult the changelog first. Indeed, changes that have been made to the components of the Pipeline Pilot collection can lead to a backwards compatibility break on your existing protocols. Then, follow the upgrade guide rather than this installation guide.

The Discngine LiveDesign Connector for Pipeline Pilot package contains:

  • ldconn: the Pipeline Pilot collection developed to interact with LiveDesign into Pipeline Pilot protocol,
  • ldconn.conf: configuration file for the LiveDesign server's nginx service,
  • ldconn_session.conf: configuration file for the LiveDesign server's nginx service.
  • A BIOVIA® Pipeline Pilot server 2017 R2 or above.
  • A Schrodinger® LiveDesign server 8.9 or 8.10.

You will also need to have:

  • ssh access to the Schrodinger® LiveDesign server, with rights to edit the nginx conf and restart nginx server,
  • access to BIOVIA® Pipeline Pilot server and rights to install packages on it and restart Apache server.
  1. On the Pipeline Pilot server, place the ldconn folder of the package in <PP Installation>\PPS\apps\discngine\.

  2. Open the command line prompt as an administrator from the windows start menu (Right click > execute as administrator) and change the directory to [scitegic_root]\bin (or [scitegic_root]/linux_bin if you are on a Linux server).

  3. Install the Discngine LiveDesign Connector collection executing the following command:

    .\pkgutil.exe -i discngine/ldconn

  4. Restart the Apache server:

    • open the Pipeline Pilot server administration page
    • navigate to Setup > Manage Server in the left pane
    • press the "Restart Apache" button
  5. The Package components and the application need some information about your LiveDesign environment. You can set the values directly into the parameters of the component, but we highly recommend to set the global properties declared for the package. To do so:

    • open the Pipeline Pilot server administration page
    • navigate to Setup > Global Property in the left pane
    • Here is the list of properties:
Property Description Required Default Value
LiveDesignServerUrl URL of your Live Design server, e.g. https://ldserver.yourcompany.com. Yes
LiveDesignVersion The version of your Live Design server (must be 8.9 or 8.10). Yes 8.10
Delimiter String delimiter used internally. Do not change it unless you have issues. Yes !!_!!
LicenseKey Your Licence key for the Pipeline Pilot Gadget. Yes
VerifySSL Whether you want want to check SSL certificate when using Pipeline Pilot Components. Set to False if you use a self-signed certificate or if you are not using SSL. Yes
DefaultProjectName Name of the LiveDesign project that will be used by components by default. No Global

First make sure you can access your LiveDesign server via ssh.

  1. Edit the ldconn.conf and replace the placeholders with the url of your Pipeline Pilot server:
location /ppproxy {
   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   proxy_set_header X-Forwarded-Proto $scheme;
   proxy_pass https://<server-url>:<port>/;
   proxy_read_timeout 600;
}

location /discngine/ldconn/ {
   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   proxy_set_header X-Forwarded-Proto $scheme;
   proxy_pass https://<server-url>:<port>/discngine/ldconn/;
   proxy_read_timeout 600;
}
  1. Copy the ldconn.conf and ldconn_session.conf file to the LiveDesign server's nginx endpoints.d folder. For example using scp:
scp /path/to/local/ldconn.conf <user>@<ld_server_url>:/etc/nginx/endpoints.d
  1. ssh to the server, then restart nginx:
sudo service nginx restart
  1. In the LiveDesign Admin Panel, under FEATURE CONFIGURATION, go to Properties. In the CUSTOM_GADGETS section, add an entry for the Discngine Gadget:
{
   // ... other gadgets
   "BIOVIA Pipeline Pilot Gadget by Discngine": "/discngine/ldconn/"
}