Skip to main content
Version: 3.9

Install the Agent Edgeware (Docker)

This guide installs the R-COM Agent Edgeware on a Linux host with Docker Compose. Use it for new installations and for upgrades.

Installing the Edgeware is step 6 of Setting Up an Agent. Create and configure the agent in the Gateway first, so that you can export its configuration at the end of this guide.

Prerequisites​

  • A Linux host with Docker and Docker Compose installed, and a user account that is allowed to run Docker commands.
  • Permission to create the installation directory (this guide uses /home/rcom_agent/).
  • Network access from the host to the container registry www.rcom-repository.de.
  • The download URL of the Agent Edgeware package and a registry token. Both are provided to your organization by your R-COM contact.
  • The network access required by the agent's connection mode. See Connection Modes.
  • An agent created in the Gateway. See Create and Manage Agents.

Step 1: Download the Package​

Download the compose package and extract it into the installation directory. Replace <download-url> with the URL you received.

wget -O rcom_agent_compose.zip "<download-url>"
unzip rcom_agent_compose.zip -d /home/rcom_agent/
cd /home/rcom_agent/

Run all further commands from /home/rcom_agent/.

Step 2: Sign In to the Container Registry​

Sign in so that Docker can pull the agent images. Replace <registry-token> with the token you received.

echo '<registry-token>' | docker login www.rcom-repository.de -u 'robot$rcom_agent+pull' --password-stdin

Using --password-stdin keeps the token out of the command line and the process list.

Step 3: Configure Environment Variables​

Create or edit the .env file in /home/rcom_agent/:

/home/rcom_agent/.env
RCOM_HOST_PORT=8091
RCOM_IMAGE_VERSION=<image-version>
VariableDescription
RCOM_HOST_PORTPort on the host where the agent's API is exposed. Use this port when you open the agent's API later, for example to apply the configuration.
RCOM_IMAGE_VERSIONImage version tag to deploy. Use the version recommended for your R-COM Gateway release.

Step 4: Start the Agent​

docker compose up -d

Docker pulls the images (if they are not already available locally) and starts the agent containers in the background.

Check that the containers are running:

docker compose ps

To follow the container output, for example while troubleshooting, run:

docker compose logs -f

Step 5: Apply the Agent Configuration​

Export the agent's configuration from the Gateway and apply it to the Edgeware, then check that the agent's status changes in the Gateway. See Connect the Agent Edgeware.

Upgrade an Existing Installation​

  1. Back up /home/rcom_agent/, including the .env file.
  2. Download and extract the new package as described in Step 1.
  3. Set RCOM_IMAGE_VERSION in .env to the new version.
  4. Run docker compose up -d again.
  5. In the Gateway, check that the agent reports the new Version on the Manage Agents page.

Secure the Installation​

  • Allow access to RCOM_HOST_PORT only from the hosts that need it: the R-COM Gateway when the agent uses the ServerToAgent connection mode, and the computer you use to apply the configuration through the agent API.
  • Store the registry token securely and do not commit the .env file to version control if it contains secrets.

Related Articles