Skip to main content

​
config.yaml

ipmideck reads its settings from data/config.yaml, written with sensible defaults on the first run. You can edit the file directly, or override any value at runtime with an environment variable (handy for Docker, see below). 
# data/config.yaml (auto-generated on first run)
server:
  host: "0.0.0.0"
  port: 3000
  https: false
auth:
  enabled: true
  session_expiry: "24h"
  max_login_attempts: 5
ipmi:
  poll_interval: 30
  power_poll_interval: 30
  command_timeout: 30
data:
  retention_days: 365
  cleanup_interval: "24h"
logging:
  level: "info"
modules:
  sensors:
    enabled: true
  fanpilot:
    enabled: true
  power:
    enabled: true
  sel:
    enabled: true
  fru:
    enabled: true
The keys above are the real, unprefixed nested keys ipmideck writes to config.yaml. Environment-variable overrides use a separate IPMIDECK_ prefix and never appear inside the YAML file itself.

​
Environment overrides

Every setting can be overridden at runtime with an IPMIDECK_-prefixed environment variable. This is the easiest way to configure ipmideck in Docker, where you do not want to edit a file inside the container.
Environment variableDescription
IPMIDECK_SERVER_HOSTHost/interface the dashboard binds to (default 0.0.0.0).
IPMIDECK_SERVER_PORTHTTP port the dashboard binds to (default 3000).
IPMIDECK_AUTH_ENABLEDEnable or disable the built-in login (default true).
IPMIDECK_AUTH_SESSION_EXPIRYHow long a login session stays valid (default 24h).
IPMIDECK_IPMI_POLL_INTERVALSeconds between BMC sensor polls (default 30).
IPMIDECK_IPMI_POWER_POLL_INTERVALSeconds between power-status polls (default 30).
IPMIDECK_DATA_RETENTION_DAYSDays of sensor history to keep before cleanup (default 365).
IPMIDECK_DATA_DB_PATHAbsolute path to the SQLite database file.
IPMIDECK_LOGGING_LEVELLog verbosity: debug, info, warning, or error (default info).
IPMIDECK_DEMORun against simulated hardware instead of real BMCs (default false).
Two more variables control file locations rather than a config.yaml value: IPMIDECK_DATA_DIR (the data directory, see below) and IPMIDECK_CONFIG_PATH (an explicit path to a config.yaml to load).
Environment variables take precedence over values in config.yaml. Set them in your docker run command (-e IPMIDECK_SERVER_PORT=8080) or your docker-compose.yml.

​
Where config lives

ipmideck resolves its data directory from IPMIDECK_DATA_DIR if set, otherwise it falls back to a platform default. config.yaml always lives at <data-dir>/config.yaml:
  • Docker: /data/config.yaml: the image sets IPMIDECK_DATA_DIR=/data; persist /data with a volume.
  • pip on Linux: /data/config.yaml by default: set IPMIDECK_DATA_DIR to relocate it.
  • pip on Windows: ./data/config.yaml, relative to the directory you run ipmideck from.

​
Next steps

  • Security: how credentials and sessions are protected.
  • Features: what each module does.