Guides & references
Documentation
FoldingOS and FoldOps are separate projects with their own repositories. FoldingOS covers the purpose-built operating system; FoldOps covers fleet monitoring — agent, supervisor, and web dashboard.
FoldingOS
A lightweight, purpose-built operating system for Folding@home compute nodes. Documentation lives in the folding-os/doc directory.
Start here
Documentation index
Full table of contents and document roles
Project charter
Mission, scope, and project values
Engineering principles
Active decision-making principles for the project
Vision
Intended user experience and long-term direction
Architecture
High-level system components and boundaries
Roadmap
Planned implementation milestones
Architecture & design
Boot process
Logical boot sequence and failure behavior
Build system
Build goals, framework, and outputs
Hardware support
Target platforms and support policy
Networking
Networking behavior and capabilities
Storage layout
Logical storage and persistence model
Security model
Runtime security architecture
FoldOps integration
How FoldingOS relates to the FoldOps fleet stack
Implementation & process
Installer
Combined-image installation architecture
Update system
Update requirements and trust model
Coding standards
Project style and engineering conventions
Testing strategy
How the project validates changes
Release strategy
Versioning and release workflow
Contributing
How to participate in the project
FoldOps
A Folding@home farm monitor for Debian nodes. Agents report metrics every 60 seconds to a central supervisor, which stores snapshots in SQLite and serves a React dashboard. Docs live in foldops/docs.
Operations
Documentation index
Full table of contents, metrics collected, and requirements
Installation
apt install from deb.folding-os.com, env files, and systemd
Configuration
Environment variables and secrets
Alerts & Discord
Webhook setup, rules, and troubleshooting
Reference
Architecture
System design, components, and data flow
API reference
HTTP endpoints and response formats
Agent
Metrics, temperature collection, and FAH log parsing
Database
SQLite schema and retention
FoldingOS integration
Binary paths, systemd, and Buildroot packaging
Rust migration
Plan to rewrite agent and supervisor in Rust
On this site
Quick-start guides and overviews hosted on folding-os.com.
Download
FoldingOS release downloads and install preview
FoldOps overview
Agent, supervisor, web dashboard, and apt install commands
Screenshots
Farm dashboard, node history, deployments, and alerts
Hardware guide
Platform recommendations, specs, and example builds
Roadmap
Project direction and upcoming work