Heex Installer
This guide will walk you through the installation process for Heex Runtime Environment on your system.
Prerequisites
- Administrator privileges or sudo rights .
- Heex Application requirements
- API_KEY. If you do not have one, please contact support@heex.io to get your API_KEY.
- If you would like to deploy your own Heex Runtime Environment, please ensure that you did this step
Installation Steps
- Download the Installer: Download the latest release from your command line.
If your system is not yet supported, contact us and we will work with you to provide you an adequate installer. The below systems are the one we have tested the installer on
| OS | Architecture | command |
|---|---|---|
| Ubuntu | x86_64 | curl -L https://heex-releases.s3.eu-west-1.amazonaws.com/installers/heex-installer-ubuntu-x86_64_latest -o heex-installer && chmod +x heex-installer |
| Ubuntu | arm64 | curl -L https://heex-releases.s3.eu-west-1.amazonaws.com/installers/heex-installer-ubuntu-arm64_latest -o heex-installer && chmod +x heex-installer |
| CentOS | x86_64 | curl -L https://heex-releases.s3.eu-west-1.amazonaws.com/installers/heex-installer-centos-x86_64_latest -o heex-installer && chmod +x heex-installer |
| Windows | arm64 | Invoke-WebRequest -Uri "https://heex-releases.s3.eu-west-1.amazonaws.com/installers/heex-installer-windows-x86_64_latest.exe" -OutFile "heex-installer.exe" |
- Run the Installer:
What will the Installer do ?
The installer will check if a system with the specified name already exists; if not, it will create a new system with the provided name.
It will attempt to fetch your custom Heex Runtime Environment, or install the default Heex Runtime Environment, which includes the Agent Kernel.
The installer will then install the runtime environment and download the associated configuration file, if defined. The installation status will be reported on the web platform.
⚠️ Warning: system name with special characters
If your system name contains special characters (i.e ’), use double quotes before and after your names. For example, for a system called test’s system, provide that as
--name“test’s system”.
- Once the download is complete, install Heex on your system with root rights. If not, use sudo.
- Once the download is complete, install Heex on your system with root rights. If not, use sudo.
- Once the download is complete, install Heex on your system, with Administrative rights
ENVbeing your heex server environment (ie: https://ENV.heex.io)
Heex Installer Command Line Options
| Option | Description |
|---|---|
| —help, -h | Show this help message and exit |
| —system_uuids, -s | System UUIDs (optional) |
| —api_key, -k | Heex API KEY |
| —environment, -e | Heex client server |
| —execution_mode, -x | execution_mode (optional) : ‘background’ or ‘service’ (default) |
| —name, -n | System display name (name of your system in the UI) (optional) |
| —middleware, -m | System middleware (ros1, ros2, apex, aveto, other) (optional) |
| —system_category, -c | System category (on-road-vehicle, boat, train, unmanned-aerial-vehicle, infrastructure, autonomous-mobile-robots, cloud-station, on-premise, dev-station) |
Verification
To confirm that Heex is correctly installed, navigate to the status page of your system on Heex Cloud by visiting https://ENV.heex.io/systems and selecting the appropriate system.
Using a PROXY
You can configure and use Proxies with the heex-installer the same way as with the CLI. If you intend to do so, please take a look at how to use a Proxy with the CLI