Installer options
Once built, the installer should be run with administrator rights. The user has the possibility to add some instructions as stated in the following table. Here is how you do it.- windows
- linux
Option | Short | Description |
---|---|---|
--help | -h | Show this help message and exit |
--mode | -m | Set the HRE mode. Possibilities are upload-only (u ), no-connectivity (n ) or limited-connectivity (l ) |
--interactive | -i | Enable interactive mode during installation. |
--uninstall | -u | Uninstall |
Installer Agent Kernel runtime configuration (-m)
Check kernel configuration for more information.Deployment execution mode (-e)
On Windows, when called, the installer will launch your Agents and Kernel as windows services that’ll be automatically ran at system startup.On Linux, the user can chose to either launch them as services or background processes since sometimes launching services is not possible (ie in docker environments). This choice is done via the
--execution
(or -e
) command, added with either service
or background
as an argument. Please understand that when in background process mode, any system reboot will not automatically re-run your agents.
Example:
Uninstallation (-u)
If you want to remove the running services (or background processes) and all the created folders, you can simply call the installer with the--uninstall
option and it’ll proceed to do so, no other input needed.
Adding custom files
If for any reason you wish to include custom files/folders of any type, we have added a dedicated space for them: theadditionalHreContent
folder, which is located at the root of your SDK folder. Any file or folder you add inside it will be copied into the Heex Runtime Environment with the same arborescence (they shall be copied inside <HRE_root>/additionalHreContent/
).
HRE’s Header and Footer files
We’ve enhanced the flexibility of our installer by introducing the capability for users to run custom code before the Heex Runtime Environment launch. To avail of this feature, prior to create your installer, you create either or both of the following files within the additionalHreContent folder:additionalHreContent/HRE_setup_header.sh
(oradditionalHreContent\HRE_setup_header.ps1
on Windows): The code added inside this file will be run (sourced on Linux, executed on Windows) before any of the HRE agents are startedadditionalHreContent/HRE_setup_footer.sh
(oradditionalHreContent\HRE_setup_footer.ps1
on Windows): The code added inside this file will be run (sourced on Linux, executed on Windows) after any of the HRE agents are started
Linux services additional environment setup
Since the installation is done asroot
, the services (or background processes) do not have access to the user’s environment variables nor the .bashrc
file.
In some advanced use cases, you may need to set some settings before running the executables.
Sourcing custom files
You can source additional files before the executables are ran. You need to add their full paths in the bash array typed variable namedFILES_TO_SOURCE_IN_SERVICES_ENV
inside the additionalHreContent/HRE_setup_header.sh
script.
⚠️ Warning:
Make sure to use full paths. The character ~
won’t correctly reference paths to your HOME directory.
📝 Note: If you mean to source several files, know that the order of the declaration of each file in the list is the order in which we source the files.
Sourcing custom variables
You can also export variables into the services or background processes. For that, you will need to create a dedicated external shell script, and declared it in theadditionalHreContent/HRE_setup_header.sh
script as mentionned above to source it before the executable gets run.
📝 Note: Any external custom script is expected to be reachable at the given static path.
Templated header file
TheadditionalHreContent/HRE_setup_header.sh
is automatically generated and added into the packaged SDK, but if the file is not present, you can create it yourself at the root of the package, and paste the following inside it:
💡 Tip: If you already have created theadditionalHreContent/HRE_setup_header.sh
script for other purposes, you can simply add theFILES_TO_SOURCE_IN_SERVICES_ENV
list into it
ROS specific configuration
In the template written above, you might notice an additionnal variable defined in it:DISABLE_AUTOMATIC_ROS_INSTALL_SEARCH
. If you do not work with ROS, you can ignore it. If you do, feel free to check out the specific ROS configuration page