mdzio/ccu-historian repository overview

⁠CCU-Historian

Dies ist das offizielle Docker-Image für den CCU-Historian⁠. Der CCU-Historian erfasst die Betriebsdaten der Zentrale CCU3 des Hausautomations-Systems HomeMatic.

Dieses Docker-Image ist kompatibel mit dem Vorgänger-Image xjokay/ccu-historian⁠, welches nicht mehr weiter gepflegt wird. Die Umgebungsvariablen und verwendeten Volumes können ohne Änderung weiter verwendet werden.

⁠Umgebungsvariablen

Die folgenden Umgebungsvariablen müssen für den ersten Start des Containers gesetzt werden. Aus diesen wird die Konfigurationsdatei ccu-historian.config generiert, wenn diese nicht bereits existiert. Die Konfigurationsdatei kann auch auf dem Volume /opt/ccu-historian/config (siehe auch weiter unten) direkt editiert werden.

Weitere Informationen sind im Handbuch des CCU-Historian im Abschnitt Konfiguration⁠ zu finden.

Folgende Umgebungsvariablen für Wartungszwecke sind optional und werden bei jedem Start des Docker-Containers erneut ausgewertet:

Weitere Informationen sind im Handbuch des CCU-Historian im Abschnitt Startparameter⁠ zu finden.

⁠Freizugegebene Netzwerk-Ports

Weitere Informationen sind im Handbuch des CCU-Historian im Abschnitt Firewall-Einstellungen⁠ zu finden.

⁠Einzurichtende Volumes

Im Ordner /opt/ccu-historian/config wird die Konfigurationsdatei ccu-historian.config auf Basis der Umgebungsvariablen erstellt, wenn sie nicht vorhanden ist.

Im Ordner /database wird die Datenbankdatei history.mv.db beim ersten Start erstellt.

⁠Automatisches Backup einrichten

Ein automatisches Backup der Datenbank kann folgendermaßen eingerichtet werden:

1. Verzeichnis backup im Volume /database erstellen.
2. Folgende Zeile zur Konfigurationsdatei ccu-historian.config hinzufügen. Dadurch wird wöchentlich ein Backup erstellt.

database.backup='/database/backup/db_%Y-w%W.zip'

⁠Log-Ausgaben aufzeichnen

Die Log-Ausgabe des CCU-Historians können für die Fehlersuche in Textdateien geschrieben werden:

1. Verzeichnis log im Volume /database erstellen.
2. Folgende Zeilen zur Konfigurationsdatei ccu-historian.config hinzufügen. Dadurch werden bis zu 10 Log-Dateien erstellt.

logSystem.fileLevel=Level.INFO
logSystem.fileName='/database/log/ccu-historian-%g.log'
logSystem.fileLimit=10000000
logSystem.fileCount=10

⁠Beispiele

⁠Start mit Docker-Compose

services:
  app:
    image: mdzio/ccu-historian
    volumes:
      - ./data/database:/database
      - ./data/config:/opt/ccu-historian/config
    ports:
      - 80:80
      - 2098:2098
      - 2099:2099
      - 8082:8082
    environment:
      - CONFIG_CCU_TYPE=CCU3
      - CONFIG_CCU_IP=192.168.1.10
      - CONFIG_HOST_IP=192.168.1.100
      - CONFIG_HOST_BINRPCPORT=2099
      - CONFIG_HOST_XMLRPCPORT=2098
      - CONFIG_CCU_PLUGIN1_TYPE=CUXD
      - CONFIG_KEEP_MONTHS=12

⁠Start mit Docker Run

docker run -d \
  -v ./data/database:/database \
  -v ./data/config:/opt/ccu-historian/config \
  -p 80:80 \
  -p 2098:2098 \
  -p 2099:2099 \
  -p 8082:8082 \
  -e CONFIG_CCU_TYPE=CCU3 \
  -e CONFIG_CCU_IP=192.168.1.10  \
  -e CONFIG_HOST_IP=192.168.1.100 \
  -e CONFIG_HOST_BINRPCPORT=2099 \
  -e CONFIG_HOST_XMLRPCPORT=2098 \
  -e CONFIG_CCU_PLUGIN1_TYPE=CUXD \
  -e CONFIG_KEEP_MONTHS=12 \
  mdzio/ccu-historian