Docker installation

Dependencies

Docker

Configuration

Configure HCL Link before running any installation commands. If you choose not to do so, you might need to re-install for your updated configuration to take effect.

There are two files to configure before installation.

Note: Do not use native post-fixed versions.
  • config.yaml

To re-configure properties from config.yaml after installation, run the update_envs.sh script after making your changes.

To re-configure properties from config.yaml, copy the file into the hip-rest container then restart it:
./Link stop --runtime
./Link start --runtime

Several directories are specified in those configuration files. If the user or group you install into lacks R/W access to these directories, a system admin needs to create them and then transfer ownership.

If you are installing as a non-root user, use ports above 1024 to avoid permission issues. The default ports values are set above 1024:
  • REST API: HTTPS 9443, HTTP 8080, see the rest section.
  • Server: HTTPS 8443, see the server tomcat and client sections.
  • UI Client: HTTPS 4443, see the client section.

Installation

Read the Link Utility documentation before following the installation steps. You may need to adjust commands according to your use-case.

The following commands are intended to demonstrate a quick-start scenario:

  • ./Link configure --type docker --integration oem
  • ./Link install
Either start all components or continue to the Troubleshooting section for any errors:
./Link start