Installing Agents via Docker Compose

How to install agents using Docker Compose.

This guide explains how to install agents via Docker Compose.

Prerequisites

• Docker and Docker Compose installed.

• A valid Connectware license key.

If multiple agents are running on the same machine, each agent must be assigned its own Docker volume. Otherwise, agents will overwrite each other’s persisted data, including username and password credentials.

Procedure

1. Log in to the Cybus Docker registry. Enter the following command in your terminal:

docker login registry.cybus.io

When prompted, enter the following credentials:

• Username: license

• Password: Your Connectware license key

1. Create a folder for your agent (e.g., myAgent).

2. Inside this folder, create a new file named docker-compose.yml.

3. Paste the following example configuration into your docker-compose.yml file. Replace ${IMAGE_TAG} with the protocol-mapper agent image version you want to use (e.g., 2.0.6).

docker-compose.yml

services:
  protocol-mapper-agent:
    image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
    environment:
      CYBUS_AGENT_MODE: distributed
      CYBUS_AGENT_NAME: myAgent
      CYBUS_HOSTNAME_INGRESS: localhost
      CYBUS_TRUST_ALL_CERTS: true
    volumes:
      - protocol-mapper-agent:/data
    restart: unless-stopped
    network_mode: host
    hostname: <some-suitable-hostname>
volumes:
  protocol-mapper-agent:

1. In your terminal, run the following command to start the agent:

docker compose up -d

1. Optional: To run the agent with root permission, add user: root to the docker-compose.yml file.

services:
  protocol-mapper-agent:
    user: root
    image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
    # ...other configuration...

Result

The agent is now installed and running. To verify, use:

docker ps

This command lists running containers. You should see protocol-mapper-agent in the output.