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 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.
Verify that the following ports are available on your machine
Required ports and related Link configuration properties:

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.
    - Verify that the following ports are available on your machine
      Required ports and related Link configuration properties:
    - Data folders used by Link
      Required data folders and related Link configuration properties:
  - Installation procedures
  - 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.

Verify that the following ports are available on your machine

Required ports and related Link configuration properties:


Default Port	Used by Link features	Configuration file location (relative to the Link installation folder)	Configuration property name
4443 , 80	Link Server	config\config.yaml	/client/inbound/port Used with /client/inbound/protocol Formerly: HIP_HTTPS_PORT,HIP_HTTP_PORT
8080	Runtime and Link Server	config\config.yaml	/tomcat/inbound/ports/http /rest/inbound/ports/http /keycloak/serverUrl (Used only if the Keycloak feature is enabled, /keycloak/enabled) Formerly: authentication.keycloak.serverUrl HIP_KEYCLOAK_SERVER_URL
8443	Runtime and Link Server	config\config.yaml	/tomcat/inbound/ports/https /server/inbound/ports/https /client/outbound/server/port /rest/inbound/authentication/server Formerly: authentication.server HIP_SERVER_HOST
8005	Runtime and Link Server	config\config.yaml	/tomcat/inbound/ports/shutdown
15901	Event Reporter	config\config.yaml	/rest/eventReporter/port Formerly: event.logger.port
15901	Event Reporter	eventreporter.properties	LISTENING_PORT

The Link windows installation will present you with a dialog that allows you to configure the Link design time (Link UI ) ports, typically 4443 and 80. The installation verifies that the port is available on the machine. The installation will not continue if the port is not available.

Also, the Link Windows installer opens a dialog that allows you to configure Link application server ports (typically ports 8080, 8443 and 8005). The Installation verifies that the selected ports are available on the machine. The installation will not continue if those ports are not available. The Event Reporter, port 15901 from the table, must be manually verified to ensure that the port is available