Skip to content

vomfive/dockermonitorimage-ha

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐳 Docker Monitor Image – Home Assistant Integration

HACS Version License: CC BY-NC 4.0

🇬🇧 English | 🇫🇷 Français


🇬🇧 English

Docker Monitor Image is a custom integration for Home Assistant. It allows you to monitor your Docker containers and update their images via the companion app Docker-Monitor-Image.

⚠️ Mandatory prerequisite: this integration only works with Docker-Monitor-Image installed and accessible on your network (exposed HTTP API). Without this app, no data will be collected and no updates will be possible.

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


📦 Installation

Via HACS (recommended)

  1. Open HACSIntegrations → click +
  2. Add this custom repository:
    https://github.com/vomfive/dockermonitorimage-ha
    
  3. Install the integration and restart Home Assistant.

Manual installation

  1. Download or clone this repository:
    git clone https://github.com/vomfive/dockermonitorimage-ha.git
  2. Copy the custom_components/docker_monitor_image folder into your <config>/custom_components/ directory.
  3. Restart Home Assistant.

🔧 Configuration

  1. Go to Settings → Devices & Services → Add Integration.
  2. Search for Docker Monitor Image.
  3. Enter:
    • Bridge name — a custom name to identify this connection (e.g., "NAS", "Server")
    • Base URL of your API (e.g., http://192.168.1.100:5000)
    • API key (if required)
  4. The integration will test the connection before proceeding.
  5. Select the Docker containers to monitor via the checkbox list.
  6. Confirm to complete the setup.

You can add multiple bridges (one per host), each with its own name and settings.


✨ Features

Feature Details
Sensors CPU (%), RAM (%, MiB), Net RX/TX (kB/s), Block Read/Write (kB/s) per container
Binary sensor Container state (Running / Stopped) with native HA device class
Update entity Image update status with one-click install via native HA update card
Multiple bridges Monitor containers across multiple Docker hosts with distinct names
Configurable refresh Per-bridge polling interval (10s – 600s, default 60s)
Graceful offline Entities go unavailable when the host is down — no error spam
Service docker_monitor_image.force_refresh — force an immediate poll from automations
Diagnostics Export debug data from the HA UI (API key redacted)
Translations English & French (config flow, options, entity names)

🔄 Options

After setup, go to the integration and click Configure to:

  1. Adjust the refresh interval (in seconds)
  2. Add or remove containers from monitoring

Changes are applied immediately (the integration reloads automatically).


❓ FAQ

Can I use the integration without Docker-Monitor-Image? No. This integration is a connector to the Docker-Monitor-Image API.

Why do the rates show 0 on the first refresh? Rates are calculated from cumulative byte counters. Two successive readings are needed to compute a speed.

What happens when I turn off a host? All entities for that bridge go unavailable. When the host comes back, data resumes automatically at the next poll.

Can I have different refresh intervals per host? Yes. Each bridge has its own configurable interval via Configure.


📜 License

CC BY-NC 4.0 This project is freely usable for non-commercial purposes. For professional or commercial use, please contact the author. View the full license


🇫🇷 Français

Docker Monitor Image est une intégration personnalisée pour Home Assistant. Elle permet de superviser vos conteneurs Docker et de mettre à jour leurs images via l'application compagnon Docker-Monitor-Image.

⚠️ Prérequis obligatoire : cette intégration fonctionne uniquement avec Docker-Monitor-Image installée et accessible sur votre réseau (API HTTP exposée). Sans cette application, aucune donnée ne sera collectée et aucune mise à jour ne sera possible.

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


📦 Installation

Via HACS (recommandé)

  1. Ouvrez HACSIntégrations → cliquez sur +
  2. Ajoutez ce dépôt personnalisé :
    https://github.com/vomfive/dockermonitorimage-ha
    
  3. Installez l'intégration et redémarrez Home Assistant.

Installation manuelle

  1. Téléchargez ou clonez ce dépôt :
    git clone https://github.com/vomfive/dockermonitorimage-ha.git
  2. Copiez le dossier custom_components/docker_monitor_image dans votre répertoire <config>/custom_components/.
  3. Redémarrez Home Assistant.

🔧 Configuration

  1. Allez dans Paramètres → Appareils & Services → Ajouter une intégration.
  2. Recherchez Docker Monitor Image.
  3. Entrez :
    • Nom du pont — un nom personnalisé pour identifier cette connexion (ex : "NAS", "Serveur")
    • URL de base de votre API (ex : http://192.168.1.100:5000)
    • Clé API (si requise)
  4. L'intégration teste la connexion avant de continuer.
  5. Sélectionnez les conteneurs Docker à superviser via la liste à cocher.
  6. Confirmez pour terminer la configuration.

Vous pouvez ajouter plusieurs ponts (un par hôte), chacun avec son propre nom et ses paramètres.


✨ Fonctionnalités

Fonctionnalité Détails
Capteurs CPU (%), RAM (%, MiB), Net RX/TX (kB/s), Block Read/Write (kB/s) par conteneur
Capteur binaire État du conteneur (En marche / Arrêté) avec device class natif HA
Entité de mise à jour Statut de mise à jour de l'image avec installation en un clic via la carte native HA
Ponts multiples Supervisez des conteneurs sur plusieurs hôtes Docker avec des noms distincts
Rafraîchissement configurable Intervalle de polling par pont (10s – 600s, défaut 60s)
Gestion hors-ligne Les entités passent en unavailable quand l'hôte est éteint — pas d'erreur en boucle
Service docker_monitor_image.force_refresh — forcer un poll immédiat depuis les automations
Diagnostics Export des données de debug depuis l'interface HA (clé API masquée)
Traductions Anglais & Français (config flow, options, noms des entités)

🔄 Options

Après la configuration, allez dans l'intégration et cliquez sur Configurer pour :

  1. Ajuster l'intervalle de rafraîchissement (en secondes)
  2. Ajouter ou retirer des conteneurs de la supervision

Les modifications sont appliquées immédiatement (l'intégration se recharge automatiquement).


❓ FAQ

Puis-je utiliser l'intégration sans Docker-Monitor-Image ? Non. Cette intégration est un connecteur vers l'API de Docker-Monitor-Image.

Pourquoi les débits affichent 0 au premier rafraîchissement ? Les débits sont calculés à partir de compteurs cumulés en octets. Il faut deux relevés successifs pour obtenir une vitesse.

Que se passe-t-il quand j'éteins un hôte ? Toutes les entités de ce pont passent en unavailable. Quand l'hôte revient, les données reprennent automatiquement au prochain poll.

Puis-je avoir des intervalles de rafraîchissement différents par hôte ? Oui. Chaque pont a son propre intervalle configurable via Configurer.


📜 Licence

CC BY-NC 4.0 Ce projet est librement utilisable à des fins non commerciales. Pour un usage professionnel ou commercial, merci de contacter l'auteur. Consulter la licence complète

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages