Home

Ferrum

Ferrum is fleet control for Proxmox VE — a single dashboard for every cluster and standalone node you run, with live inventory, dashboards, backups, HA, firewall, alerting, automation, and more. One statically-linked Go binary serves the REST API, the console WebSocket proxy, and the embedded React frontend on a single port — no external database required by default (SQLite, with optional PostgreSQL for multi-instance deployments).

This wiki is the deeper reference behind the README: what each area of the product does, how to configure it, and how to get unstuck. For a quick-start, the README's Getting started section is the fastest path to a running instance.

Pages

• Installation — Docker, native binaries (systemd/Windows Service), and building from source.
• Configuration — config.yaml / FERRUM_* environment variables, and what's configured from the UI instead.
• Features — a tour of every area: fleet overview, inventory, topology, storage, backups, HA, firewall, SDN, alerts & automation, PBS remotes, cross-cluster migration, and access control.
• AI Assistant and MCP — the built-in AI Assistant, the local Needle 2 model, and using Ferrum as an MCP server from Claude Code/Desktop or any other MCP client.
• Troubleshooting — common problems and how to diagnose them.

Getting help

• Found a bug or want a feature? Open an issue.
• Releases (binaries + a multi-arch Docker image) are published automatically on GitHub whenever a vX.Y.Z tag is pushed — see the Releases page.
• Ferrum is MIT licensed.