Home
Installation Guide
The documentation provide here describes how to install the Design Server, as well as system requirements for both Windows and Linux.
Linux installation
You have the choice of two installation types: Native and Docker.
Link Utility
After you extract the HCL Link package, you can interact with the Link script to begin installation.
CONFIGURE command
The CONFIGURE command is required before using any other command. This command is used to specify the installation type, the license file location, and the user/group that the installation is associated with upon completion.

Installation Guide
The documentation provide here describes how to install the Design Server, as well as system requirements for both Windows and Linux.
- Windows installer
  This documentation describes how to install the HCL Link Design Server using the Windows Installer.
- Linux installation
  You have the choice of two installation types: Native and Docker.
  - Example installation
    Example files demonstrate the installaton.
  - Link Utility
    After you extract the HCL Link package, you can interact with the Link script to begin installation.
    - CONFIGURE command
      The CONFIGURE command is required before using any other command. This command is used to specify the installation type, the license file location, and the user/group that the installation is associated with upon completion.
    - INSTALL, UNINSTALL, START, STOP commands
      The behavior of the INSTALL, UNINSTALL, START and STOP commands is similar so we can group them for simplicity.
    - STATUS command
      The STATUS command retrieves the status of each HCL Link component. Though the usage is similar between the native and docker installation types, the possible states are different.
    - LOGS command
      The LOGS command prints the primary log of the chosen component.
  - Native installation
    Procedures for installing Design Server using the Native installation.
  - Docker installation
    Procedures for installing Design Server using the Docker installation.
  - Troubleshooting
    Documentation to describe how to troubleshoot an installation.

CONFIGURE command

The CONFIGURE command is required before using any other command. This command is used to specify the installation type, the license file location, and the user/group that the installation is associated with upon completion.

You can rely on the default values, but it is recommended that you specify --type and --license-file

CONFIGURE command options


--type <native\|docker>	Specify the installation type. Default: native
--integration	This option is intended for customer use only. Do not use if you purchased HCL Link as a standalone product.
--license-file	Specify the license file to use for the HCL Link runtime. Use full path with no spaces.
--user	The user to install HCL Link as. This determines which user has ownershi of the processes and directories. This must be an existing user. Default: current user.
--group	The group to install HCL Link as. This provides you with the flexibility to share HCL Link directories with a group of administrators. Default: current group

Note: You cannot change the integration type after you run install. If you notice an error after installation, you must extract the HCL Link package into a new directory and begin again.