mirror of
https://github.com/anand34577/ferrum.git
synced 2026-09-20 17:43:21 +00:00
Anand
4ae41a6f1d
- docs/: GitHub Pages site (landing page, docs, live click-through demo) served straight from /docs, no build step. - web-demo/: source for the demo (a copy of web/ with its API layer mocked in-memory) — see web-demo/README.md to rebuild docs/demo after a change. - web/src/lib/auth.tsx: signOut() no longer clears the whole query cache; wiping ["auth","setup-status"] forced it to refetch and re-armed `loading`, stranding the user on a loading/failed screen instead of the Login page. Only non-auth queries are dropped now. - .gitignore: exclude web-demo/node_modules and web-demo/dist (build output, already published as docs/demo). - Drop PRODUCT.md (internal planning brief, not meant for the public repo). - README: link the new docs/demo site.
111 lines
6.8 KiB
HTML
111 lines
6.8 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>Documentation — Ferrum</title>
|
|
<meta name="description" content="Ferrum documentation: build from source, install on Linux, Windows, macOS, or Docker, configure it, and use every feature.">
|
|
<link rel="icon" type="image/svg+xml" href="../assets/favicon.svg">
|
|
<link rel="stylesheet" href="../assets/css/site.css">
|
|
</head>
|
|
<body>
|
|
<header class="topnav">
|
|
<div class="container topnav-row">
|
|
<a href="../index.html" class="brand">
|
|
<span class="brand-mark" aria-label="Ferrum (Fe)"><span class="bm-num">26</span><span class="bm-sym">Fe</span></span>
|
|
Ferrum
|
|
</a>
|
|
<nav class="navlinks">
|
|
<a href="../index.html#features">Product</a>
|
|
<a href="../index.html#look">Screenshots</a>
|
|
<a href="./index.html" aria-current="page">Docs</a>
|
|
<a href="../demo/index.html">Demo</a>
|
|
<a href="https://github.com/anand34577/ferrum/releases" target="_blank" rel="noopener">Releases</a>
|
|
</nav>
|
|
<div class="nav-actions">
|
|
<button class="icon-btn" data-theme-toggle aria-label="Toggle color theme">
|
|
<svg class="i-moon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"><path d="M20 14.5A8 8 0 1 1 9.5 4a6.5 6.5 0 0 0 10.5 10.5Z"/></svg>
|
|
<svg class="i-sun" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="4"/><path d="M12 2v2M12 20v2M4.9 4.9l1.4 1.4M17.7 17.7l1.4 1.4M2 12h2M20 12h2M4.9 19.1l1.4-1.4M17.7 6.3l1.4-1.4"/></svg>
|
|
</button>
|
|
<a class="icon-btn" href="https://github.com/anand34577/ferrum" target="_blank" rel="noopener" aria-label="View source on GitHub">
|
|
<svg viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.58 2 12.25c0 4.53 2.87 8.37 6.84 9.73.5.1.68-.22.68-.5 0-.24-.01-1.04-.01-1.88-2.78.62-3.37-1.22-3.37-1.22-.46-1.2-1.11-1.52-1.11-1.52-.9-.64.07-.63.07-.63 1 .07 1.53 1.06 1.53 1.06.89 1.57 2.34 1.11 2.91.85.09-.67.35-1.11.63-1.37-2.22-.26-4.56-1.14-4.56-5.07 0-1.12.39-2.03 1.03-2.75-.1-.26-.45-1.31.1-2.72 0 0 .84-.28 2.75 1.05a9.28 9.28 0 0 1 5 0c1.9-1.33 2.74-1.05 2.74-1.05.56 1.41.2 2.46.1 2.72.65.72 1.03 1.63 1.03 2.75 0 3.94-2.35 4.8-4.58 5.06.36.32.68.94.68 1.9 0 1.37-.01 2.48-.01 2.81 0 .28.18.61.69.5A10.03 10.03 0 0 0 22 12.25C22 6.58 17.52 2 12 2Z"/></svg>
|
|
</a>
|
|
<a class="btn btn-primary btn-sm" href="../demo/index.html">Live demo</a>
|
|
<button class="nav-toggle" data-nav-toggle aria-label="Open menu" aria-expanded="false">
|
|
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round"><path d="M4 7h16M4 12h16M4 17h16"/></svg>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
<div class="container doc-shell">
|
|
<nav class="doc-nav" aria-label="Documentation">
|
|
<div>
|
|
<h5>Getting started</h5>
|
|
<ul>
|
|
<li><a href="./index.html" aria-current="page">Overview</a></li>
|
|
<li><a href="./installation.html">Installation</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<h5>Setup</h5>
|
|
<ul>
|
|
<li><a href="./configuration.html">Configuration</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<h5>Using Ferrum</h5>
|
|
<ul>
|
|
<li><a href="./features.html">Features & workflows</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<h5>Integrations</h5>
|
|
<ul>
|
|
<li><a href="./api.html">API, MCP & audit log</a></li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
<article class="doc-content">
|
|
<div class="doc-kicker">Documentation</div>
|
|
<h1>Everything you need to run Ferrum</h1>
|
|
<p>Ferrum is one Go binary with an embedded web UI. There's no separate services to stand up, no message queue, no external cache: SQLite is enough for most installs, and Postgres is there when you want to run more than one instance against the same database. This guide covers building it, installing it on whatever you're running, configuring it, and using what it does once it's up.</p>
|
|
|
|
<h2>Where to start</h2>
|
|
<p>If you just want it running, skip straight to <a href="./installation.html">Installation</a>; there's a one-line installer for Linux, a Windows service installer, prebuilt Docker images, and instructions for building from source yourself. Once it's running:</p>
|
|
<ol>
|
|
<li>Open the UI and create the initial admin account. The very first visitor to a fresh install gets offered this; nobody else ever will.</li>
|
|
<li>Add a Proxmox connection from <strong>Connections</strong>: host, port, and either an API token or a username/password.</li>
|
|
<li>Give it a minute to pull inventory, then the fleet dashboard, topology, and alerts start populating on their own.</li>
|
|
</ol>
|
|
|
|
<div class="callout note">
|
|
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="9"/><path d="M12 16v-5M12 8h.01"/></svg>
|
|
<p>A connection can be a full PVE cluster, a single standalone node, or a Proxmox Backup Server remote, and you can add as many as you have. Ferrum treats each one as an independent source and rolls them all up in the fleet views.</p>
|
|
</div>
|
|
|
|
<h2>How the docs are organized</h2>
|
|
<p><strong><a href="./installation.html">Installation</a></strong>: building from source, and installing a release build on Linux (systemd), Windows (service), macOS, or via Docker, plus how to upgrade and uninstall cleanly.</p>
|
|
<p><strong><a href="./configuration.html">Configuration</a></strong>: everything in <code>config.yaml</code> and its <code>FERRUM_*</code> environment variable equivalents: the database driver, TLS and reverse-proxy behavior, the encryption secret, OIDC single sign-on, and the built-in local AI provider.</p>
|
|
<p><strong><a href="./features.html">Features & workflows</a></strong>: what each area of the app does and how to configure it: the dashboard, inventory and consoles, storage and backups, HA/firewall/SDN, alerting and automation, and access control.</p>
|
|
<p><strong><a href="./api.html">API, MCP & audit log</a></strong>: generating API keys, calling the REST API, wiring an MCP-capable agent up to Ferrum, and where every mutating action gets logged.</p>
|
|
|
|
<div class="doc-footnav">
|
|
<span></span>
|
|
<a href="./installation.html"><span class="lbl">Next</span><span class="ttl">Installation →</span></a>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<footer class="site-footer">
|
|
<div class="container footer-bottom" style="margin-top:0; padding-top:0; border-top:none;">
|
|
<span>© 2026 Ferrum. Open source under the MIT license.</span>
|
|
<a href="https://github.com/anand34577/ferrum" target="_blank" rel="noopener">github.com/anand34577/ferrum</a>
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="../assets/js/site.js"></script>
|
|
</body>
|
|
</html>
|