Install, operate, and extend BenchOS
BenchOS documentation is organized around the public source release: what the system includes, how to install it, how to deploy it safely, and where contributors should start.
Setup Paths
Choose the route that matches how you want to run BenchOS
Local installation
Install the server and client, configure the initial admin account, and run BenchOS locally with the public source release.
Single-user setup
Set up BenchOS for an individual scientist who wants local-first notebook, registry, storage, sequence, and tool workflows.
Lab deployment
Separate app code, runtime data, uploads, secrets, and profiles for a shared lab deployment behind HTTPS.
What It Includes
One self-hosted research workspace
Operator Reference
Make private lab deployment explicit
Configuration
Environment variables, runtime paths, profile selection, email delivery, integrations, and optional agent settings.
Docker agent runtime
Optional isolated runtime support for BenchOS skills and assistant workflows.
Security and backups
Guidance for secrets, runtime data, uploads, backups, and release hygiene.
Upgrading
Operational workflow for updating a BenchOS installation without mixing app code and private runtime data.
Release Hygiene
Public code, private runtime data
BenchOS docs should reinforce the boundary between source code and lab-specific runtime state: no `.env` files, uploads, logs, backups, private profiles, databases, API keys, or generated data in Git.