Docker Obkio Agent Installation Guide

    What you are going to learn:

  • How to install the Obkio Monitoring Agent on Docker

Docker Logo

How to use this Docker image?
How to use this Docker image?

Obkio maintains the public image obkio/agent image at DockerHub. This image contains an installer with auto-update that will keep the software up-to-date. The software will be automatically installed in /opt/obkio on every execution. Usually there is no need for a custom Dockerfile to use this image.

$ docker run -d --privileged \
             -e AGENT_ID=<id> \
             -e AGENT_SECRET_KEY=<secret_key> \
             obkio/agent

Incoming Connections
Incoming Connections

To accept incoming connections, you must expose the ports 23999/TCP and 23999/UDP.

Permanent Storage
Permanent Storage

The software is stored inside /opt/obkio. By configuring permanent storage, the start-up time will be faster if the latest software release is already installed. Also, the AGENT_SECRET_KEY environment variable is not required when using permanent storage.

Environment Variables
Environment Variables

  • AGENT_ID: This variable is the Agent ID. required

  • AGENT_SECRET_KEY: This variable is required only if /opt/obkio is not on permanent storage. The key can be generated only once per agent. When ready, visit https://agent-api.obkio.com/agent/install/<AGENT_ID>/key/.

Docker Agent Limitations
Docker Agent Limitations

If the host is Windows or macOS, it is not possible to mark DSCP/TOS settings for the monitoring sessions.

Firewall Settings
Firewall Settings

As for all other agent types, some firewall configurations might be required if outbound connections are filtered. Refer to the article Firewall Configurations for more details.