Skip to content

Docker Agent

The Docker agent is the generic installation path for hosts that can reach local services and run Docker or Docker Compose.

Requirements

  • Docker on a host in the local network.
  • An agent token from the Tunely dashboard.
  • A persistent volume mounted at /data.
  • Outbound network access to Tunely.

Start the Container

sh
docker volume create tunely-agent-data

docker run -d \
  --name tunely-agent \
  --restart unless-stopped \
  -e TOKEN="${TOKEN:?set TOKEN}" \
  -v tunely-agent-data:/data \
  ghcr.io/tunely-eu/agent

Set TOKEN in your shell first:

sh
export TOKEN="agent-token-from-the-dashboard"

Docker Compose

yaml
services:
  tunely-agent:
    image: ghcr.io/tunely-eu/agent
    container_name: tunely-agent
    restart: unless-stopped
    environment:
      TOKEN: ${TOKEN:?set TOKEN}
    volumes:
      - tunely-agent-data:/data

volumes:
  tunely-agent-data:

Operations

Show recent logs:

sh
docker logs --tail=100 tunely-agent

Update:

sh
docker compose pull tunely-agent
docker compose up -d tunely-agent

Network Note

The internal target address of a service must be reachable from the agent container. In a Compose project, this can be a service name. For other hosts in the LAN, a LAN IP address or local DNS name is often the right choice.

Public documentation for Tunely.