Getting Started

Everything you need to know to get started with Formant.

    Configure SSH & port forwarding

    There are 2 steps to enabling SSH. Both of these configurations are enabled by default. 

    1. Enable SSH, at agent install time, on the device.

    2. Enable SSH dynamically, on the agent, through configuration

    Enable SSH on the device at installation time

    Info

    SSH is enabled by default on Formant agents. This step is only necessary if you have previously disabled SSH on this device. If you want to use SSH, read the help doc entitled SSH to your robot.

    If SSH is disabled on the agent, it needs to be enabled before you can use configuration to enable/disable it dynamically.

    1. Set port_forwarding to false on the agent

    echo formant-agent formant-agent/port_forwarding boolean "true" | sudo debconf-set-selections

    2. Restart formant agent for the new settings to take effect

    sudo systemctl restart formant-agent

    Enable SSH dynamically using configuration

    Once SSH is enabled on the device, it can be enabled or disabled using the agent configuration settings as shown below. 

    From the burger menuselect Settings ⇒ Devices on the Device Name ⇒ General Settings ⇒ set SSH & Port Forwarding slider to ON

    Disable SSH dynamically using configuration

    SSH can be dynamically disabled using configuration using the following instruction.

    From the burger menuselect Settings ⇒ Deviceson the Device name ⇒ General Settings ⇒ set SSH & Port Forwarding slider to OFF

    Disable SSH on the device

    SSH is enabled by default on the agent. If you would like to disable it, set port forwarding to false before installing the agent.

    echo formant-agent formant-agent/port_forwarding boolean "false" | sudo debconf-set-selections

    If the Formant agent is already installed, uninstall the agent, then set port forwarding value to false and then reinstall the agent.

    Want to learn more?

    If you want to learn more about how SSH is implemented, please visit our deep dive into SSH

    © 2020 Formant • 1999 Bryant St · San Francisco, CA 94110