# ====================================== # RabbitNUT - UPS Monitor Configuration # ====================================== [ups] # Network UPS Tools (NUT) server connection settings # These parameters define how to connect to your NUT server # IP address or hostname of the NUT server # Examples: "192.168.1.100", "ups.local", "localhost" host = "10.0.31.1" # UPS name as configured on the NUT server # This must match the UPS name defined in the NUT server's ups.conf file # Use 'upsc -l' on the NUT server to list available UPS names # Common examples: "ups", "ups1", "apc1500", "eaton5px" name = "ups" # NUT server port number # Default: 3493 (standard NUT port) port = 3493 # NUT server authentication credentials (optional) # Uncomment and set these only if your NUT server requires authentication # These must match a user configured in your NUT server's upsd.users file #username = "admin" #password = "Password123" [monitoring] # How often to poll the UPS for status updates (in seconds) # Lower values = more responsive but higher network/CPU usage # Recommended: 5-30 seconds for most deployments poll_interval = 5 [shutdown] # Automatic shutdown configuration # Controls when and how the system shuts down during power events # Master switch for automatic shutdown functionality # Set to false to only monitor without taking action enabled = true # === Shutdown Triggers === # The system will initiate shutdown when ANY of these conditions are met: # 1. Time on battery power (in seconds) # Triggers shutdown after running on battery for this duration # Example: 300 = shut down after 5 minutes on battery on_battery_seconds = 300 # 2. Minimum battery charge level (percentage) # Triggers shutdown when battery drops below this level # Range: 0-100 # Recommended value depends on your specific setup: # - UPS capacity vs load (higher load = set higher threshold) # - Battery age and health (older batteries = set higher threshold) # - Critical system requirements (longer graceful shutdown = higher threshold) battery_percent_threshold = 20 # 3. Estimated runtime remaining (in seconds) # Triggers shutdown when UPS reports less runtime available # Example: 180 = shut down with 3 minutes runtime left runtime_threshold = 180 # === Shutdown Execution === # System command to execute for shutdown # Linux examples: # - Immediate: "/sbin/shutdown -h now" # - With delay: "/sbin/shutdown -h +1" (1 minute warning) # - Power off: "/sbin/poweroff" # Windows example: "shutdown /s /t 0" # macOS example: "sudo shutdown -h now" shutdown_command = "/sbin/shutdown -h +0" # Delay before executing shutdown command (in seconds) # Gives time to save work or cancel if power returns # During this period, shutdown can be cancelled if conditions improve shutdown_grace_period = 30 [logging] # Application logging configuration # File path for log output (optional) # Uncomment to enable file logging # Ensure the directory exists and is writable by the service user # Common locations: # - Linux: "/var/log/rabbitnut.log" # - Windows: "C:\\ProgramData\\rabbitnut\\rabbitnut.log" # If not specified, logs will only be written to stdout/stderr #log_file = "/var/log/rabbitnut.log" # Logging verbosity level # Options (from least to most verbose): # - "error": Only errors # - "warn": Errors and warnings # - "info": Normal operation messages (recommended) # - "debug": Detailed operational information # - "trace": Very detailed debugging information log_level = "info" [metrics] # Metrics API endpoint configuration # Exposes UPS status data for monitoring systems (Prometheus, Grafana, etc.) # Enable/disable the metrics HTTP endpoint enabled = false # TCP port for the metrics HTTP server # Ensure this port is not already in use port = 8089 # Optional security token for accessing metrics # When set, requests must include header: "Authorization: Bearer <token>" # Comment out for no authentication (not recommended for production) # Generate a secure token with: openssl rand -hex 32 bearer_token = "secure-monitoring-token-123" # Output format for metrics data # Options: # - "openmetrics": Prometheus/OpenMetrics text format (recommended) # - "json": JSON format for custom integrations format = "openmetrics"