Skip to content

finder39/ha-dockge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dockge for Home Assistant

hacs_badge GitHub release

Home Assistant integration for managing Docker container updates via the Dockge REST API.

Monitor update availability across all your Docker stacks, toggle auto-updates per stack, and trigger updates — all from within Home Assistant.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Features

  • Update monitoring — per-stack and per-container binary sensors for available image updates
  • Container status — sensors showing each container's state (running, exited, etc.) with image and health details
  • Auto-update control — per-stack switches to enable/disable automatic updates
  • Update actions — buttons to update individual stacks, check for updates, update all, or trigger a scheduled run
  • Scheduler status — sensor showing auto-update scheduler state, cron expression, and next run times
  • Update history — sensor tracking the most recent stack update with result details
  • Multi-agent support — works with multiple Dockge agents, each with their own device hierarchy

Prerequisites

This integration requires a Dockge instance with the REST API enabled. You will need:

  • A running Dockge instance (fork with REST API and update management)
  • An API key configured in Dockge

Installation

HACS (Recommended)

  1. Open HACS in your Home Assistant instance
  2. Click the three dots in the top right and select Custom repositories
  3. Add https://github.com/finder39/ha-dockge with category Integration
  4. Click Download on the Dockge card
  5. Restart Home Assistant

Or click the button above to add the repository directly.

Manual

  1. Copy the custom_components/dockge/ directory to your Home Assistant custom_components/ folder
  2. Restart Home Assistant

Configuration

  1. Go to Settings > Devices & Services > Add Integration
  2. Search for Dockge
  3. Enter your Dockge URL (e.g., http://192.168.1.100:5001)
  4. Enter your API key
  5. Optionally adjust the scan interval (default: 300 seconds)

Entities

Agent-level (Dockge Server device)

Type Entity Description
Sensor Image Updates Available Count of stacks with available updates
Sensor Server Summary Running container count with per-stack breakdown in attributes
Sensor Auto-Update Scheduler Scheduler status with cron details (primary agent only)
Sensor Last Stack Update Timestamp of most recent update (primary agent only)
Sensor Next Auto Update Next scheduled auto-update time (primary agent only)
Sensor Next Image Check Next scheduled image check time (primary agent only)
Sensor Global Summary Aggregate across all agents (multi-agent only, on primary device)

Stack-level (per stack device)

Type Entity Description
Binary Sensor Update Available On when stack has image updates
Binary Sensor {container} Update Available On when a specific container has updates
Sensor {container} Container state with image and health attributes
Button Update Pull latest images and recreate the stack
Button Check Updates Check for new image updates
Switch Auto Update Enable/disable auto-updates for this stack

Services

All services are available under the dockge domain (e.g., dockge.start_stack). The optional agent field accepts an agent display name (e.g., "Gastly") for multi-agent setups; leave empty for the primary server.

Service Fields Description
start_stack stack_name, agent? Start a Docker Compose stack
stop_stack stack_name, agent? Stop a Docker Compose stack
restart_stack stack_name, agent? Restart a Docker Compose stack
update_stack stack_name, agent? Pull latest images and recreate a stack
check_updates stack_name, agent? Check for image updates on a stack
update_all agent? Update all stacks (optionally on a specific agent)
trigger_auto_updates (none) Trigger auto-updates on all stacks with auto-update enabled
system_prune agent? Run Docker system prune to clean up unused images, containers, and networks

Dashboard Card

For a visual dashboard, check out the Dockge Card — a custom Lovelace card that auto-discovers your servers and stacks with real-time status, actions, and processing indicators.

Community

Vibecoded

This integration was built entirely through vibe coding with Claude Code.

License

MIT

About

Home Assistant integration for managing Docker container updates via Dockge

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages