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.
INSTALL, UNINSTALL, START, STOP commands
The behavior of the INSTALL, UNINSTALL, START and STOP commands is similar so we can group them for simplicity.

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.

INSTALL, UNINSTALL, START, STOP commands

The behavior of the INSTALL, UNINSTALL, START and STOP commands is similar so we can group them for simplicity.

All commands will act upon the default components if none are specified as options. You can finetune the scope of each action by listing individual components.

INSTALL, UNINSTALL, START, STOP options


--runtime	Runtime REST API
--design-server	Design Server