Documentation

New here?

Read Quickstart first — it walks you from git clone to a fully fused worker in about ten minutes. Then dip into Architecture for the three-circle mental model. Everything else is a reference you'll come back to as you go.

All pages

• Quickstart

  Zero to fused worker in ten minutes. Prerequisites, master deploy, admin signup, UI tour, your first worker host, and the fuse handshake.

• Architecture

  The three-circle model, sub-container fleet, mesh networking, database schema, and security model.

• Configuration

  Every TOML option for master and worker. Environment variable overrides, the _FILE secret idiom, and validation rules.

• Worker Onboarding

  Deep dive on the install snippet, every CONTEXTBAY_* env var, the bootstrap call, fuse handshake, persistence, and refreshing workers.

• Operations

  Make targets, the volume protocol, auth recovery, log locations, and the one-liners you reach for during incidents.

• Observability

  Prometheus, Grafana, Loki, Tempo, Pyroscope, Alertmanager. Master metrics, host-onboarding counters, and rule reload.

• Backups

  Volume-level backup jobs, restore from a record, verification, and offsite downloads.

• Project Registry

  Manual project records, claude-context bundles, the local-mode git scanner, and the Portainer redeploy hook.

• Discord

  Enable the bot, set scopes and intents, configure channels and roles, opsec sanitization, and the slash-command surface.

• API Reference

  Every REST endpoint, gRPC service, and WebSocket event. Grouped by module with method, path, role, and a short description.

• Troubleshooting

  Common issues and debug commands for installation, enrollment, mesh, database, and modules.

Prerequisites at a glance

Supported platforms: Linux amd64/arm64, macOS amd64/arm64. Windows via WSL2.

Modules at a glance

ContextBay is modular. Most modules are on by default; flip any to false in [modules] to remove its API routes, sidebar entries, and background services.