Skip to main content

Frends Agent Docker Quick Start

Basic steps for running a Frends Agent in Docker

T
Written by Tikriti Shabudin
Updated over a year ago

Prerequisites

Install Docker here.

Create and Download Agent Config

In the Frends UI create a cross-platform Frends Agent.

Under Advanced settings turn off the "Allow new agents to connect to agent group" option.

Download the Agent config using the "Configuration only" option.

Get the Frends Version

Get the Frends version number from the Frends UI (top right drop-down menu).

You can also find it using curl:

curl https://tenantname.frendsapp.com/api/navigation/getUIVersion

Start the Container

You can start the container with the following command replacing {full local path to config.json} with the full local path to the downloaded agent configuration file and {FrendsVersion} with the Frends Version from the UI.

The -v parameter mounts the downloaded local agent config json file in the container under /app/secrets/appsettings.secrets.json

Frends 5.7 and above

docker run -it -v {full local path to config.json}:/app/secrets/appsettings.secrets.json frendsplatform/frends-agent-linux:{FrendsVersion}

e.g. docker run -it -v c:\downloads\downloaded_agent_config:/app/secrets/appsettings.secrets.json frendsplatform/frends-agent-linux:5.7.3.1739

Frends 5.6 and below

docker run -it -v {full local path to config.json}:/secrets/appsettings.secrets.json frendsplatform/frends-agent-linux:{FrendsVersion}

e.g. docker run -it -v c:\downloads\downloaded_agent_config.json:/secrets/appsettings.secrets.json frendsplatform/frends-agent-linux:5.6.4.1943

If successful you should see the Frends Agent run through the initial config steps and then appear online in the UI.

Note. the commands will differ slightly if using Linux, for example the full local path to config.json.

Customization

For setting different settings please see this article.

Did this answer your question?