Docker Guard Help

Install the Agent
EN DE

Contents

Overview Getting started Install Agent Troubleshooting FAQ
Docker host
Install the Docker Guard Agent

The Docker Guard Agent is a lightweight container that exposes a read-only HTTP API to monitor your Docker host. It runs alongside your existing containers and reads from the Docker socket — no port forwarding or external services required.

What you need

  • A host running Docker Engine (Linux, Synology DSM 7+, TrueNAS SCALE, Unraid, …).
  • Access to the Docker socket (/var/run/docker.sock).
  • A reachable port on your local network (default: 18080).
  • The Docker Guard iOS app installed.

1) Generate an API key

Pick a long, random string. The Agent only accepts requests with a matching X-API-Key header.

openssl rand -hex 32

2) Deploy via docker compose

Save the following as docker-compose.yml and run docker compose up -d:

services:
  docker-guard-agent:
    container_name: docker-guard-agent
    image: registry.git.no-logs.de/hans/docker-guard-agent-images:latest
    pull_policy: always
    restart: unless-stopped
    ports:
      - '18080:8080'
    environment:
      - DOCKERGUARD_API_KEY=<your-api-key>
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - docker-guard-data:/data

volumes:
  docker-guard-data:
Important:
  • The Docker socket is mounted read-only for monitoring. Mount it without :ro only if you want to use start/stop/restart actions (Control Pack required in the app).
  • Replace <your-api-key> with the value you generated.
  • Change the host port (18080) if it is already in use on your machine.

3) Verify the Agent is running

curl -k https://<host-ip>:18080/health
Expected result: 
{"status":"ok","version":"0.1.0"}

4) Configure the iOS app

  1. Open Docker Guard on iOS and go to Settings.
  2. Under Agent Connection enter:
    • Agent URL: https://<host-ip>:18080
    • API Key: the value from step 1
  3. Tap Connect.
The Dashboard now shows your containers, images, volumes, networks and host info.
Next: Troubleshooting
docker-guard.no-logs.de