<USER_SECRET_KEY>
by your personnal user secret key):
⚠️ 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. To do so, you can either create a new system directly using the heex-installer
, or you can install an existing system that has already been set up:
📝 Note: You can call./heex-installer --help
to list the different--system-category
possible values, and more.
Option | Description |
---|---|
--help , -h | Show this help message and exit. |
--system-id , -si | [optional] System Identification Number. If not given, you will create a new system. |
--api-key , -k | [mandatory] User secret API key. |
--execution-mode , -x | [optional] Execution mode: background or service (defaults to service ). |
--name , -n | [mandatory if no system_id provided] System display name (name of your system in the UI). |
--system-middleware , -mid | [optional] System middleware: value should be an integer. You can use ./heex-installer --help to list all the available middlewares. |
--system-category , -cat | [mandatory if no system_id provided] System category: value should be an integer. Example for RAIL: --system-category 5 . You can use ./heex-installer --help to list all available categories. |
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.