ab36ba6f81
Add a Proxmox VE importer that reads the /api2/json REST API with a read-only
API token and drops hosts (proxmox), VMs (vm) and LXC containers (lxc) onto the
canvas as typed nodes with run state and hardware specs (vCPU/RAM/disk).
- Backend: proxmox_service (httpx) + proxmox routes (test-connection, import,
import-pending, config). Two-tier dedupe — merge onto an existing scanned node
by IP, else synthetic pve-{host}-{vmid} identity. Update-in-place, never
deletes. Host->guest rendered as a 'virtual' edge via the pending-link flow.
- Security: token is env-only (PROXMOX_TOKEN_*), never written to disk by the
app, never returned by any endpoint; errors are credential-sanitized.
- Auto-sync: optional scheduled re-import into pending (APScheduler job).
- PendingDevice.properties carries specs through approve (+ migration).
- Frontend: ProxmoxImportModal, sidebar entry, pending inventory source filter,
Settings auto-sync section, proxmoxApi client.
- Docs: docs/proxmox-import.md, README + FEATURES sections, .env.example keys.
- Tests: backend service/router/scheduler, frontend modal/client/pending.
ha-relevant: maybe
160 lines
6.9 KiB
Python
160 lines
6.9 KiB
Python
import json
|
|
import logging
|
|
from pathlib import Path
|
|
|
|
from pydantic import model_validator
|
|
from pydantic_settings import BaseSettings, SettingsConfigDict
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
def _read_version() -> str:
|
|
for candidate in [
|
|
Path(__file__).parent.parent.parent.parent / "VERSION", # repo root (dev)
|
|
Path("/app/VERSION"), # Docker image
|
|
]:
|
|
if candidate.exists():
|
|
return candidate.read_text().strip()
|
|
return "unknown"
|
|
|
|
APP_VERSION = _read_version()
|
|
|
|
|
|
class Settings(BaseSettings):
|
|
model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")
|
|
|
|
secret_key: str # Required — set SECRET_KEY in .env
|
|
sqlite_path: str = "./data/homelab.db"
|
|
# Uploaded media (floor plans, and future raw image uploads) live on disk,
|
|
# not in the DB. Defaults to a `uploads/` folder next to the SQLite DB so it
|
|
# sits on the same persistent Docker volume. Override with UPLOAD_DIR.
|
|
upload_dir: str = ""
|
|
cors_origins: list[str] = ["http://localhost:5173", "http://localhost:3000"]
|
|
|
|
# JWT
|
|
algorithm: str = "HS256"
|
|
access_token_expire_minutes: int = 1440 # 24h
|
|
|
|
# Auth — set AUTH_USERNAME and AUTH_PASSWORD_HASH in .env
|
|
auth_username: str = "admin"
|
|
auth_password_hash: str = ""
|
|
|
|
@model_validator(mode="after")
|
|
def check_password_hash(self) -> "Settings":
|
|
h = self.auth_password_hash
|
|
if h and not h.startswith("$2"):
|
|
logger.error(
|
|
"AUTH_PASSWORD_HASH looks invalid (does not start with '$2b$'). "
|
|
"bcrypt hashes contain '$' signs — wrap the value in single quotes "
|
|
"in your .env file: AUTH_PASSWORD_HASH='$2b$12$...'"
|
|
)
|
|
return self
|
|
|
|
# Scanner
|
|
scanner_ranges: list[str] = ["192.168.1.0/24"]
|
|
|
|
# Deep scan — persisted defaults (overridable per-scan from the scan dialog).
|
|
# http_ranges: extra nmap port ranges, opt-in, no default. Probe + TLS off by default.
|
|
scanner_http_ranges: list[str] = []
|
|
scanner_http_probe_enabled: bool = False
|
|
scanner_http_verify_tls: bool = False
|
|
|
|
# Status checker
|
|
status_checker_interval: int = 60
|
|
|
|
# Per-service status checker (independent of node checks). Off by default.
|
|
service_check_enabled: bool = False
|
|
service_check_interval: int = 300
|
|
|
|
# MCP service key — set MCP_SERVICE_KEY in .env
|
|
# Used by the MCP server to authenticate against the backend without a user password.
|
|
# Leave empty to disable MCP service key auth.
|
|
mcp_service_key: str = ""
|
|
|
|
# Live view — optional read-only public canvas endpoint.
|
|
# Set to a random secret string to enable /api/v1/liveview?key=<value>.
|
|
# Leave unset (or empty) to keep the feature disabled (default).
|
|
liveview_key: str | None = None
|
|
|
|
# Homepage widget — optional read-only stats endpoint for gethomepage.
|
|
# Set to a random secret to enable /api/v1/stats/summary (X-API-Key header).
|
|
# Leave empty to keep the feature disabled (default).
|
|
homepage_api_key: str = ""
|
|
|
|
# Proxmox VE import.
|
|
# Token = a real credential → env/.env ONLY, never persisted by the app to
|
|
# scan_config.json and never returned by the API. token_id is
|
|
# 'user@realm!tokenname'; use a read-only PVEAuditor role.
|
|
proxmox_token_id: str = ""
|
|
proxmox_token_secret: str = ""
|
|
# Non-secret connection + auto-sync config (persisted via save_overrides).
|
|
proxmox_host: str = ""
|
|
proxmox_port: int = 8006
|
|
proxmox_verify_tls: bool = True
|
|
proxmox_sync_enabled: bool = False
|
|
proxmox_sync_interval: int = 3600 # seconds (floor 300 enforced on write)
|
|
|
|
def _override_path(self) -> Path:
|
|
return Path(self.sqlite_path).parent / "scan_config.json"
|
|
|
|
def media_dir(self) -> Path:
|
|
"""On-disk folder for uploaded media. Sits on the same persistent
|
|
volume as the SQLite DB unless UPLOAD_DIR is set."""
|
|
if self.upload_dir:
|
|
return Path(self.upload_dir)
|
|
return Path(self.sqlite_path).parent / "uploads"
|
|
|
|
def load_overrides(self) -> None:
|
|
"""Load runtime scan config overrides written by the API."""
|
|
try:
|
|
data = json.loads(self._override_path().read_text())
|
|
if "scanner_ranges" in data:
|
|
self.scanner_ranges = data["scanner_ranges"]
|
|
if "status_checker_interval" in data:
|
|
self.status_checker_interval = int(data["status_checker_interval"])
|
|
if "service_check_enabled" in data:
|
|
self.service_check_enabled = bool(data["service_check_enabled"])
|
|
if "service_check_interval" in data:
|
|
self.service_check_interval = int(data["service_check_interval"])
|
|
if "scanner_http_ranges" in data:
|
|
self.scanner_http_ranges = list(data["scanner_http_ranges"])
|
|
if "scanner_http_probe_enabled" in data:
|
|
self.scanner_http_probe_enabled = bool(data["scanner_http_probe_enabled"])
|
|
if "scanner_http_verify_tls" in data:
|
|
self.scanner_http_verify_tls = bool(data["scanner_http_verify_tls"])
|
|
# Proxmox non-secret config (token stays env-only, never here).
|
|
if "proxmox_host" in data:
|
|
self.proxmox_host = str(data["proxmox_host"])
|
|
if "proxmox_port" in data:
|
|
self.proxmox_port = int(data["proxmox_port"])
|
|
if "proxmox_verify_tls" in data:
|
|
self.proxmox_verify_tls = bool(data["proxmox_verify_tls"])
|
|
if "proxmox_sync_enabled" in data:
|
|
self.proxmox_sync_enabled = bool(data["proxmox_sync_enabled"])
|
|
if "proxmox_sync_interval" in data:
|
|
self.proxmox_sync_interval = int(data["proxmox_sync_interval"])
|
|
except Exception:
|
|
pass
|
|
|
|
def save_overrides(self) -> None:
|
|
"""Persist scan config so it survives container restarts."""
|
|
self._override_path().parent.mkdir(parents=True, exist_ok=True)
|
|
self._override_path().write_text(json.dumps({
|
|
"scanner_ranges": self.scanner_ranges,
|
|
"status_checker_interval": self.status_checker_interval,
|
|
"service_check_enabled": self.service_check_enabled,
|
|
"service_check_interval": self.service_check_interval,
|
|
"scanner_http_ranges": self.scanner_http_ranges,
|
|
"scanner_http_probe_enabled": self.scanner_http_probe_enabled,
|
|
"scanner_http_verify_tls": self.scanner_http_verify_tls,
|
|
# Proxmox: only non-secret config. Token fields are intentionally
|
|
# excluded — they must never be written to disk by the app.
|
|
"proxmox_host": self.proxmox_host,
|
|
"proxmox_port": self.proxmox_port,
|
|
"proxmox_verify_tls": self.proxmox_verify_tls,
|
|
"proxmox_sync_enabled": self.proxmox_sync_enabled,
|
|
"proxmox_sync_interval": self.proxmox_sync_interval,
|
|
}))
|
|
|
|
|
|
settings = Settings() # type: ignore[call-arg]
|