Install agent from terminal
This help page describes the process of installing the agent from the command line terminal. If you are interested in installing from our web interface, please visit our documentation on installing agent from web.
We currently support
To get set up with Formant's Debian repository you will need to add our repo to the machine's source list:
sudo echo "deb https://repo.formant.io/formant/debian $(lsb_release -cs) main" >>/etc/apt/sources.list
Next, add Formants gpg key:
sudo apt-key adv --fetch-keys https://keys.formant.io/formant.pub.gpg
Verify that you now have the key with the fingerprint, B7E5 E1C5 4CBF FE9B 9275 0DCD A0ED 2D6C C0E2 E57F, by searching for the last 8 characters of the fingerprint.
sudo apt-key fingerprint C0E2E57F pub rsa2048 2020-03-11 [SC] [expires: 2022-03-11] B7E5 E1C5 4CBF FE9B 9275 0DCD A0ED 2D6C C0E2 E57F uid [ unknown] Formant <firstname.lastname@example.org> sub rsa2048 2020-03-11 [E] [expires: 2022-03-11]
Install the agent
To install the agent you can simply run the following script. However, before running these steps, please see all the configuration options below.
sudo apt update sudo apt install formant-agent
Agent installation configuration
Before installing the agent, there are several configuration options that can be set via
If you are using a provisioning token for the installation it can be set with:
echo formant-agent formant-agent/token password "<token>" | sudo debconf-set-selections
<token> with your token
Provision with Formant credentials
Using a token is preferred over using Formant Credentials for security reasons, however, we do allow the provisioning of agents with credentials. You can do this via:
echo formant-agent formant-agent/email string "<email>" | sudo debconf-set-selections echo formant-agent formant-agent/password password "<password>" | sudo debconf-set-selections
<password> with your credentials.
ROS master URI
If you are on ROS you will need to setup the agent with the ROS Master URI:
echo formant-agent formant-agent/ros_master_uri string "<ros_master_uri>" | sudo debconf-set-selections
<ros_master_uri> with the correct value.
ROS catkin workspace
The agent supports parsing of custom ROS message types, however we need to source the
setup.bash file located within that workspace.
echo formant-agent formant-agent/catkin_ws string "<catkin_ws>" | sudo debconf-set-selections
<catkin_ws> with the absolute path to your catkin workspace.
Note: The agent assumes the
setup.bash file is in
/<catkin_ws>/devel/setup.bash. If your setup file is in a different location use source_script.
To support custom locations of catkin workspace setup files, the agent allows a custom location for a script to source.
echo formant-agent formant-agent/source_script string "<source_script>" | sudo debconf-set-selections
<source_script> with the absolute path to the script to source.
The agent installation supports setting parameters for system resource usage for
Set these with:
echo formant-agent formant-agent/cpu_quota string "<cpu_quota>" | sudo debconf-set-selections echo formant-agent formant-agent/memory_limit string "<memory_limit>" | sudo debconf-set-selections
cpu_quota: The value of the CPUQuota parameter, which is expressed in percentage, specifies how much CPU time the unit gets at maximum, relative to the total CPU time available on one CPU.
memory_limit: Use suffixes K, M, G, or T to identify Kilobyte, Megabyte, Gigabyte, or Terabyte as the unit of measurement.
You can install the agent in a disabled state with the
service_enable parameter. This is
true by default.
echo formant-agent formant-agent/service_enable boolean "<enable>" | sudo debconf-set-selections
<enable> can be
Disable auto-start on boot
By default, we enable auto-start on boot for the Formant Agent. To disable auto-start on boot, run:
systemctl disable formant-agent
The agent supports port forwarding to power remote SSH, SCP, and other advanced networking tools. This can be controlled via configuration as well, however for security purposes we support disabling this at install time. This is
true by default.
echo formant-agent formant-agent/port_forwarding boolean "<enable>" | sudo debconf-set-selections
<enable> can be
Formant also supports over-the-air updates of the agent via a separate Debian sidecar package called
To enable OTA all you need to do is install this additional package:
sudo apt update sudo apt install formant-sidecar
By default, the agent creates a
formant user and group on the host system with no sudo permissions. However, to perform upgrades the
formant-sidecar adds restricted sudo capabilities to the
formant user. When the package is installed you can see them at
The restricted permissions are:
formant ALL=(ALL) NOPASSWD:/usr/bin/apt update, /usr/bin/apt install --upgrade-only -y formant-agent, /usr/bin