Skip to main content

config.yaml

ipmideck liest seine Einstellungen aus data/config.yaml, die beim ersten Start mit sinnvollen Voreinstellungen geschrieben wird. Sie können die Datei direkt bearbeiten oder jeden Wert zur Laufzeit mit einer Umgebungsvariablen überschreiben (praktisch für Docker, siehe unten).
Die obigen Schlüssel sind die echten, nicht präfixierten verschachtelten Schlüssel, die ipmideck in config.yaml schreibt. Umgebungsvariablen-Überschreibungen verwenden ein separates IPMIDECK_-Präfix und erscheinen nie innerhalb der YAML-Datei selbst.

Umgebungs-Überschreibungen

Jede Einstellung kann zur Laufzeit mit einer IPMIDECK_-präfixierten Umgebungsvariablen überschrieben werden. Das ist der einfachste Weg, ipmideck in Docker zu konfigurieren, wo Sie keine Datei innerhalb des Containers bearbeiten möchten. Zwei weitere Variablen steuern Speicherorte von Dateien statt eines Werts in config.yaml: IPMIDECK_DATA_DIR (das Datenverzeichnis, siehe unten) und IPMIDECK_CONFIG_PATH (ein expliziter Pfad zu einer zu ladenden config.yaml).
Umgebungsvariablen haben Vorrang vor Werten in config.yaml. Setzen Sie sie in Ihrem docker run-Befehl (-e IPMIDECK_SERVER_PORT=8080) oder Ihrer docker-compose.yml.

Wo die Konfiguration liegt

ipmideck löst sein Datenverzeichnis aus IPMIDECK_DATA_DIR auf, falls gesetzt, andernfalls greift es auf eine plattformabhängige Voreinstellung zurück. config.yaml liegt immer unter <data-dir>/config.yaml:
  • Docker: /data/config.yaml: das Image setzt IPMIDECK_DATA_DIR=/data; bewahren Sie /data mit einem Volume auf.
  • pip unter Linux: standardmäßig /data/config.yaml: setzen Sie IPMIDECK_DATA_DIR, um es zu verschieben.
  • pip unter Windows: ./data/config.yaml, relativ zu dem Verzeichnis, aus dem Sie ipmideck ausführen.

Nächste Schritte