everbridge/flow-designer-agent repository overview

The Flow Designer Agent is a service you install on a local system so you can run Flow Designer steps and process scripts behind your company firewall.

The agent processes steps and integrations the same way they are processed in the cloud, with the key difference being that the agent can use local resources that are not accessible from the cloud. This allows interaction with the file system or communication with applications that cannot be accessed externally; for example, populating a service desk ticket with information or requesting user information from a proprietary system.

The agent queues tasks and then processes them in order. You can configure multiple agents to distribute processing or to co-locate them with the services they need to access.

⁠How to use this image

First, login to Flow Designer and navigate to Workflows > Agents. On the Available tab, you will see the installation commands. Copy the values for XMATTERS_HOSTNAME, XMATTERS_KEY and API_KEY and keep them handy.

Next, create a file named ".env" on your local machine to hold the environment variables and add the following text:

XMATTERS_HOSTNAME=
XMATTERS_KEY=
API_KEY=
FRIENDLY_NAME=

Set the variables as follows:

• XMATTERS_HOSTNAME should point to your hostname. Note: Do not include the https:// portion.

• Set XMATTERS_KEY to the value provided in the install command block in the UI.

• Set API_KEY to the value from the install command block.

• FRIENDLY_NAME is whatever label you want to use to identify the agent in the Flow Designer UI.

Save and close the file. If you want to use Docker Compose, skip ahead to the next section and follow those instructions.

If you want to use docker run, open a terminal and run the following command (you can replace "agent-container" with your preferred name for the container):

docker run -d --restart=unless-stopped --env-file .env --name agent-container docker.io/everbridge/flow-designer-agent:latest

⁠Using image with Docker Compose

Using the instructions above, retrieve the environment variables from Flow Designer and create a file named ".env" on your local server with the environment variables.

In the same folder as the .env file, create a file named "docker-compose.yml" and add the following text:

version: '3.8'

services:
  xagent:
    image: everbridge/flow-designer-agent:latest
    container_name: flow-designer-agent
    restart: unless-stopped
    env_file:
      - .env

Save the file, and then run the following command to launch the container:

docker compose up -d

To check the health of the agent, navigate to Workflows > Agents again and click the Installed tab. Click Details beside the agent to expand it and view more information.

⁠Support

For more information about the agent, including how to configure communication via a proxy server and other ways to use this image, consult the online documentation available by clicking any help button within Flow Designer.