Dockhand for Home Assistant (Marketplace integration)

About

Dockhand is an integration that monitors and controls Docker environments through the Dockhand management UI. It adds environments, containers, stacks, networks, images, volumes, and schedules to Home Assistant as devices and entities, using the same API as the Dockhand web interface. Entities include sensors, binary sensors, buttons for restart, deploy, redeploy and update checks, switches for auto update and auto deploy, and update entities for containers. Optional runtime controls let a container's CPU, memory, and process limits and restart policy be changed, except for Compose-managed containers. It works locally with no cloud services, and authenticates with an API token or runs without one when Dockhand authentication is disabled. Setup happens in the UI, where poll intervals and optional sensor groups can be chosen and later changed in options.

Automatic summary of the README and code of raetha/ha-dockhand. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
From the Marketplace Installed through the Marketplace, formerly HACS.
Actively maintained Its author released or pushed a change in the last six months.

Provides

Switches
Sensors

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Connect to Dockhand

API URLThe base URL of your Dockhand instance.
Verify SSL certificateUncheck to allow self-signed or untrusted SSL certificates. Only disable if your Dockhand instance uses a self-signed cert.

Dockhand API Token

API TokenA Dockhand API token starting with dh_. Generate one under Profile → API tokens in the Dockhand UI.

Configure polling and features

Fast poll interval (seconds) — stats, containers & stacksHow often to refresh container, stack, and environment stats. Default: 60. Minimum: 10.
Slow poll interval (seconds) — images, volumes, networks, schedulesHow often to refresh images, volumes, networks, and schedules. Default: 600. Minimum: 30.
Enable schedule sensorsEnables sensors for Dockhand maintenance schedules.
Enable image sensorsEnables sensors for Docker images on each environment.
Enable volume sensorsEnables sensors for Docker volumes on each environment.
Enable network sensorsEnables sensors for Docker networks on each environment.
Enable runtime controls (advanced)Creates number/select entities to change a stack-less container's CPU, memory, and process limits, and restart policy, live. Not available for Compose-managed containers.
Enable container and stack CPU/memory/network/disk I/O sensorsCreates CPU, memory, network, and disk I/O sensors for each container, plus totals for each stack. Off by default since it's a lot of entities most people don't need; turning it off also removes any already-created ones.
Enable update entitiesCreates a Home Assistant update entity for every container. Turn this off if you manage updates another way and don't want Dockhand's containers in HA's own update management. Also hides the 'Update all' button; 'Check for updates' keeps working either way.
Enable precise update versionsUpgrades update entities to show precise version numbers (image digests) via periodic registry queries, instead of just an image tag. Also the only way to see update status for Dockhand's own protected containers (itself and Hawser) — Dockhand never exposes their update status through its regular cached update-check data. Requires 'Enable update entities' above.
Precise update check interval (seconds)How often to run the registry queries above (seconds). Default: 86400 (24 hours). Minimum: 300.

Re-authenticate with Dockhand

API TokenA Dockhand API token starting with dh_.

Reconfigure Dockhand

API URLThe base URL of your Dockhand instance.
Verify SSL certificateUncheck to allow self-signed or untrusted SSL certificates.
API TokenYour current token is shown masked. Clear it and save to disable authentication (you will be prompted again if the server still requires it). Enter a new value to rotate credentials.

After setup

Fast poll interval (seconds) — stats, containers & stacksHow often to refresh container, stack, and environment stats. Default: 60. Minimum: 10.
Slow poll interval (seconds) — images, volumes, networks, schedulesHow often to refresh images, volumes, networks, and schedules. Default: 600. Minimum: 30.
Enable schedule sensorsEnables sensors for Dockhand maintenance schedules.
Enable image sensorsEnables sensors for Docker images on each environment.
Enable volume sensorsEnables sensors for Docker volumes on each environment.
Enable network sensorsEnables sensors for Docker networks on each environment.
Enable runtime controls (advanced)Creates number/select entities to change a stack-less container's CPU, memory, and process limits, and restart policy, live. Not available for Compose-managed containers.
Enable container and stack CPU/memory/network/disk I/O sensorsCreates CPU, memory, network, and disk I/O sensors for each container, plus totals for each stack. Off by default since it's a lot of entities most people don't need; turning it off also removes any already-created ones.
Enable update entitiesCreates a Home Assistant update entity for every container. Turn this off if you manage updates another way and don't want Dockhand's containers in HA's own update management. Also hides the 'Update all' button; 'Check for updates' keeps working either way.
Enable precise update versionsUpgrades update entities to show precise version numbers (image digests) via periodic registry queries, instead of just an image tag. Also the only way to see update status for Dockhand's own protected containers (itself and Hawser) — Dockhand never exposes their update status through its regular cached update-check data. Requires 'Enable update entities' above.
Precise update check interval (seconds)How often to run the registry queries above (seconds). Default: 86400 (24 hours). Minimum: 300.

Texts from the code of raetha/ha-dockhand.

Entities

Binary sensorsOnline, Activity collection, Metrics collection, Vulnerability scanning, Update checks, Auto update, Image pruning, Sync error, Updates available
ButtonsCheck for image updates, Restart, Deploy, Redeploy, Update all containers
NumbersMemory limit, CPU limit, Process limit
SelectsRestart policy
SensorsCPU usage, Memory usage, Containers, Stacks, Image count, Volume count, Network count, Disk usage, Activity events, State, Health, Status, and 16 more
SwitchesAuto update, Auto deploy

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Dockhand can't reach part of its data

From the README

Monitor and control your Docker environments through Dockhand — a modern Docker management UI. This integration exposes environments, containers, stacks, networks, images, volumes, and schedules as Home Assistant devices and entities, using the same API as the Dockhand web UI.
No cloud services are used. Supports API token authentication and works with Dockhand instances where authentication is disabled.

From the README of raetha/ha-dockhand, MIT License. Shortened.