Druks has three distinct audiences: operators run the platform, extension authors build applications on it, and contributors change Druks itself. Start with the route that matches what you are doing.
- Concepts and guarantees — platform versus extension ownership, durable execution, recovery, gates, events, harnesses, sandboxes, and the access boundary.
- README — short project overview and installation entry point.
- Full local setup — Druks and sandbox containers on one machine.
- Deployment runbook — remote
exeorawsinstall, upgrades, rollback, logs, and public ingress. - Configuration — environment settings, dashboard settings, integrations, MCP, skills, and stored-secret handling.
- Connect your agent — the
/mcpendpoint, personal access tokens, and client configuration. - Troubleshooting — symptom-driven diagnosis for boot, webhooks, harnesses, sandboxes, gates, and recovery.
- Writing an extension — scaffold a separately packaged application and use workflows, agents, gates, events, webhooks, settings, routes, and migrations.
- Concepts and guarantees — the ownership contract behind the author API.
- Contributing — contribution process, change scope, and pull-request expectations.
- Development — local services, backend and frontend processes, architecture map, migrations, and verification.
- Security policy — private vulnerability reporting.
- Release process — immutable image tags, release checks, and rollback inputs.
- Open-source cut — one-time clean-history publication and public repository settings.
- Frontend guide — dashboard shell, compile-time extension UI registry, and frontend commands.
The repository intentionally uses plain Markdown rather than a documentation framework. The pages above are the navigation; internal research and temporary design notes do not belong in this index.