Files
pulse/.env.example
T

98 lines
3.6 KiB
Bash

# Example .env file for Pulse configuration
# Copy this file to .env and replace placeholder values with your actual credentials.
# --- Proxmox VE Endpoint 1 (Required) ---
# Connection details for your primary Proxmox VE host or cluster endpoint.
PROXMOX_HOST=your-proxmox-ip-or-hostname
PROXMOX_PORT=8006 # Optional, defaults to 8006 if omitted
# Authentication: Use *either* API Token (Recommended) *or* User/Password.
# API Token (Recommended):
PROXMOX_TOKEN_ID=your-api-token-id@pam!your-token-name # e.g., root@pam!pulse
PROXMOX_TOKEN_SECRET=your-api-token-secret-uuid # The Secret UUID value
# User/Password (Less Recommended):
# PROXMOX_USERNAME=your-proxmox-username # e.g., root
# PROXMOX_PASSWORD=your-password
# PROXMOX_REALM=pam # Optional, defaults to 'pam' if omitted (e.g., pam, pve, ad)
# Optional: Set a friendly name for this endpoint in logs/UI (defaults to host)
PROXMOX_NODE_NAME=My Primary Proxmox
# Optional: Allow self-signed certificates (defaults to true if omitted)
# Set to false if you have a valid certificate from a trusted CA.
PROXMOX_ALLOW_SELF_SIGNED_CERTS=true
# Optional: Enable/Disable this endpoint (defaults to true if omitted)
# PROXMOX_ENABLED=true
# --- Proxmox VE Endpoint 2 (Optional) ---
# Duplicate these variables with a _2 suffix for a second PVE endpoint.
# PROXMOX_HOST_2=second-proxmox-ip-or-hostname
# PROXMOX_PORT_2=8006
# PROXMOX_TOKEN_ID_2=token-id@pam!token-name_2
# PROXMOX_TOKEN_SECRET_2=token-secret-uuid_2
# PROXMOX_NODE_NAME_2=My Second Proxmox
# PROXMOX_ALLOW_SELF_SIGNED_CERTS_2=true
# PROXMOX_ENABLED_2=true
# ... User/Password_2 if needed ...
# --- Proxmox VE Endpoint 3, 4, ... (Optional) ---
# Continue the pattern with _3, _4, etc. for more endpoints.
# PROXMOX_HOST_3=...
# PROXMOX_TOKEN_ID_3=...
# PROXMOX_TOKEN_SECRET_3=...
# ...
# --- Proxmox Backup Server (PBS) Endpoint 1 (Optional) ---
PBS_HOST=your-pbs-ip-or-hostname
PBS_PORT=8007 # Optional, defaults to 8007 if omitted
# Authentication: Use *either* API Token *or* User/Password.
# API Token (Recommended):
# PBS_TOKEN_ID=your-pbs-api-token-id@pbs!your-token-name # e.g., pulse-reader@pbs!pulse-token
# PBS_TOKEN_SECRET=your-pbs-api-token-secret-uuid
# User/Password (Less Recommended):
PBS_USER=root@pam # e.g., root@pam or backup-user@pbs
PBS_PASSWORD=your-password
PBS_REALM=pbs # Optional, defaults to 'pbs' if using User/Password auth
# Optional: Set a friendly name for this endpoint in logs/UI (defaults to host)
PBS_NODE_NAME=My Primary PBS
# Optional: Allow self-signed certificates (defaults to true if omitted)
PBS_ALLOW_SELF_SIGNED_CERTS=true
# --- Proxmox Backup Server (PBS) Endpoint 2 (Optional) ---
# Duplicate these variables with a _2 suffix for a second PBS endpoint.
# PBS_HOST_2=second-pbs-ip-or-hostname
# PBS_PORT_2=8007
# PBS_TOKEN_ID_2=token-id@pbs!token-name_2
# PBS_TOKEN_SECRET_2=token-secret-uuid_2
# PBS_NODE_NAME_2=My Second PBS
# PBS_ALLOW_SELF_SIGNED_CERTS_2=true
# ... User/Password_2 if needed ...
# --- Proxmox Backup Server (PBS) Endpoint 3, 4, ... (Optional) ---
# Continue the pattern with _3, _4, etc. for more endpoints.
# PBS_HOST_3=...
# PBS_TOKEN_ID_3=...
# PBS_TOKEN_SECRET_3=...
# ...
# Development Settings
ENABLE_HOT_RELOAD=true # Set to false to disable hot reload
# --- Pulse Interval Configuration (Optional) ---
# Adjust how frequently Pulse fetches data. Lower values mean more real-time data
# but increase load on PVE/PBS hosts. Values are in milliseconds.
#
# PULSE_METRIC_INTERVAL_MS=2000 # Default: 2000 (2 seconds) - Frequency for fetching guest CPU/Mem/IO stats.
# PULSE_DISCOVERY_INTERVAL_MS=30000 # Default: 30000 (30 seconds) - Frequency for fetching node/guest lists and PBS data.