-
-
Notifications
You must be signed in to change notification settings - Fork 205
Deployment Decision Guide
Choose a topology from trust boundaries and recovery needs, not from user count alone. CCAM's persistence rule is constant: exactly one active dashboard writer per SQLite volume.
| Situation | Recommended path | Why |
|---|---|---|
| One developer, one machine | Native local install or desktop app | Lowest complexity; loopback is the trust boundary |
| One always-on host, small trusted team | Docker/Podman Compose behind TLS | Reproducible services and straightforward volume backup |
| Existing cluster and platform operations | Helm or Kustomize | Persistent volume, secrets, probes, network policy, controlled rollout |
| Repeatable deployment into an existing cluster | Terraform wrapping the Helm chart | Infrastructure workflow without changing CCAM's single-writer model |
| Several developer machines | One central instance plus remote sources or authenticated remote hooks | Consolidated view without multiple writers |
Do not use HPA, active-active replicas, blue/green dashboard writers, or shared concurrent writers against one database. Availability comes from retained storage, verified backups, quick replacement, and rollback.
npm run setup
npm run build
npm startKeep the default loopback bind unless another machine genuinely needs access.
Dashboard only:
docker compose up -d --buildFull local operations stack:
npm run docker:full:up
npm run monitoring:verifyThe supplied services bind to loopback by default. Explicitly design TLS, tokens, and edge routing before changing that.
Use one replica, a ReadWriteOnce persistent volume, Recreate-style ownership transfer, externalized secrets, and an immutable image tag or digest. Run:
npm run deploy:validatebefore deployment. The repository chart and manifests encode the one-writer constraint.
- One and only one dashboard writer can mount the database.
- Dashboard, hook, and MCP tokens are distinct.
- Public traffic terminates TLS.
- Hooks and MCP are exposed only if required.
- Backup and restore were tested, not merely configured.
- Health and metrics are monitored.
- Rollback uses a known image and preserves the database.
- Transcript/database access is limited to trusted operators.
Exact manifests and commands: Deployment reference.
Start Here · Localized product Wiki · Repository · Releases · Security · Report an issue
Guidance tracks the current master branch. For a deployed release, consult the repository documentation at that release tag before changing configuration.
CCAM Handbook
Use CCAM
- Read the dashboard
- Sessions and agents
- Kanban and tasks
- Tokens and costs
- Run agents
- Personal settings
Operate CCAM
- Deployment guide
- Hook health
- Security
- Backups and retention
- Prometheus and Grafana
- Remote machines
- Upgrades and rollback
- Incident runbooks
Automate and extend
- CLI patterns
- MCP workflows
- Alerts and webhooks
- Dynamic workflows
- Skills and plugins
- Safe config explorer
- Integration patterns
Help