Home
Installation
Everything you need to know to install HCL Link.
Windows installer
This documentation describes how to install the HCL Link using the Windows Installer.
Installation procedures
Modify an existing installation
If you modify any of the settings in <installation root>\config\config.yaml, then you must restart the Link application.

Installation
Everything you need to know to install HCL Link.
- Windows installer
  This documentation describes how to install the HCL Link using the Windows Installer.
  - Link Server Components
    The Link windows installation has the following components:
  - Installation prerequisites
    If you have a previous version of Link installed, you must uninstall it completely. Link windows installation does not support multiple Link installations on a single computer.
  - Installation procedures
    - Installing Link Server with Install Shield
      To install Link, complete the following steps:
    - Manually Installing Link Server and Runtime
      The Link Install Shield typically installs all the features. If you do not select Link Server and Runtime at Link Install Shield Installation time, you can install them later.
    - Post installation action
      Modify Windows user access to Link application.
    - Modify an existing installation
      If you modify any of the settings in <installation root>\config\config.yaml, then you must restart the Link application.
  - Starting and Stopping Link application
    After Installing, to start and stop Link , follow the steps:
  - Accessing Link
    Instructions for accessing the Link.
  - Customizing the installation
    HCL Link customization instructions.
  - Customizing the Redis and Link Databases
    HCL Link installation includes Redis server. If you want to use a preinstalled Redis server, you must customize your Link installation.
  - Customizing Link URL and Selecting HTTPS protocol
  - Uninstalling Link
    Instructions for uninstalling Link.
  - Troubleshooting the installation
    In the case of Link Install/Start/Stop errors, review the log files from this folder:
  - Troubleshooting Link installation process
    If Link installation fails, verify that ports listed in the table are available on your machine.
- Linux installation
  You have the choice of two installation types: Native and Docker.
- The Link configuration file config.yaml
- Using the OneDB wire listener as a MongoDB server
  The OneDB wire listener may be used in place of a MongoDB server when it is suitably configured.
- HCL Link design data
  The documentation provided here describes data backup, data restoration, and data migration of HCL Link design data.
- Configuring SSL certificates for Link
  After installing Link, setup the custom SSL certificates for the Link web UI and the Link runtime application server.

Modify an existing installation

If you modify any of the settings in <installation root>\config\config.yaml, then you must restart the Link application.