Install the Edgekeeper Docker Agent

Before you start

Use a server with Docker and Docker Compose installed, outbound HTTPS connectivity to Edgekeeper, and access to a public-IP lookup service. Create an Agent in Workspace Agents and copy its token. Keep the token private; it authenticates reports for that Agent.

Run an Agent at each server location whose public IP you need to track. If traffic uses a VPN or proxy, the reported IP may be that network’s egress address. Verify it before assigning domains or Atlas projects.

Create the deployment files

In a dedicated directory, create a .env file with the token from Workspace Agents. Do not commit this file or publish it in logs:

EDGEKEEPER_AGENT_TOKEN=REPLACE_WITH_YOUR_AGENT_TOKEN

Save the following as compose.yaml. The public image uses the latest tag. No host port or Docker socket mount is needed.

services:
  edgekeeper-agent:
    image: linkappai/edgekeeper-agent:latest
    container_name: edgekeeper-agent
    restart: unless-stopped
    environment:
      EDGEKEEPER_URL: https://edgekeeper.linapp.ai
      EDGEKEEPER_AGENT_TOKEN: ${EDGEKEEPER_AGENT_TOKEN:?Set your Agent token}
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

On Linux, restrict the environment file permissions and start the container:

chmod 600 .env
docker compose pull
docker compose up -d
docker compose logs --tail 50 edgekeeper-agent

Verify the connection

Look for the initial connection message, then check Workspace Agents for Online status and the expected public IPv4. Successful heartbeats are intentionally quiet; absence of repeated success logs does not mean the Agent has stopped.

Assign domains or Atlas integrations to this Agent after checking its IP. For failures, inspect container status and recent logs. A 403 can come from an invalid token or an upstream security rule; a 502 or fetch failure may indicate service or network unavailability. Check the response and server logs before changing security settings.

Update or rotate a token

Pull and recreate the container to use the latest published image:

docker compose pull
docker compose up -d
docker compose ps

For a token rotation, update .env and recreate with docker compose up -d --force-recreate. Treat the previous token as invalid after rotation. Keep log limits enabled to prevent unbounded container logs.

The Agent reports IP and health information. Provider credentials and DNS or Atlas changes are handled by the Edgekeeper service.