How to configure an Agent in Frends

Before installing a new Agent, you need to set up an Agent to your Agent Group. This guide will take you through the available settings to you.

Requirements

Before an Agent can be set up, you will need to have an Environment and an Agent Group ready. If you haven't yet, you can check the guide at Creating new Environments & Agent Groups.

How to set up an Agent in Frends

Setting up a Frends Agent will only require you to create a name for it, and have an Active Directory or local user account created for the Frends Agent service to run with on your server.

It is suggested that the name of the Agent reflects the server or machine the Agent is installed to. It could be the name of the server itself or even its IP address, as an example.

Note that the user account must be in local admin group on the server.

Ports for REST API define which ports the Agent will listen to for incoming connections for API requests. In order to successfully receive the API requests and trigger Processes connected to your published APIs, the ports need to be opened in your firewall.

Note that Frends versions 5.7 and later only listen for HTTPS connections, with HTTP being deprecated.

External address provides the Frends Tenant and UI information about in which address your APIs are located in. If your server environment has a domain set up that directs the requests to your Agent server, you can provide the domain here.

Alternatively, if the Agent's server is only accessible in your internal network, you can also provide the internal DNS name for your server here, with what it is accessible with from other machines in your internal network.

If the external address is filled here the Agent log page, among others, will display the URLs for each Trigger active on your Agent. Note that the value and and the further displayed values are for display purposes only, they have no technical background other than making it easier to find the URL to access your APIs from.

If you have predefined SSL certificate that you want to use with the Agent, provide its thumbrint to SSL Certificate thumbprint field. Otherwise, leave empty for a new SSL certificate to be generated for you.

To save your Agent set up, click on Save changes.

Installing the Agent

After setting up the Agent settings in your Frends Tenant, you can download its installation and configuration files from the Agent Group view.

To learn more about setting up a Server for your Frends Agent and installing the Agent on it, head over to Installing Frends Agent guide.