Handbook - Overview

Runtime Modes

CloudGrid has two supported runtime mode pairs. The deployment mode and auth mode must match.

On this page

CloudGrid has two supported runtime mode pairs. The deployment mode and auth mode must match.

Deployment modeAuth modeUse forLoginCompany model
locallocalDevelopment, local evaluation, trusted demosNo loginOne visible local company named Personal
deployedssoShared environments and production-target deploymentsGitHub, Google, or Azure Entra ID SSOConfigured deployed company boundary

Invalid combinations fail startup with ERR-009 CONFIG_INVALID:

  • CLOUDGRID_DEPLOYMENT_MODE=local with CLOUDGRID_AUTH_MODE=sso
  • CLOUDGRID_DEPLOYMENT_MODE=deployed with CLOUDGRID_AUTH_MODE=local
  • CLOUDGRID_AUTH_MODE=sso without CLOUDGRID_AUTH_PROVIDERS
  • enabled SSO providers without their required provider variables

Local Mode

Local mode is optimized for the first useful experience:

CLOUDGRID_DEPLOYMENT_MODE=local
CLOUDGRID_AUTH_MODE=local

In local mode, CloudGrid bootstraps the Personal company and durable local projects. The ordinary application project is default; the local CloudGrid service telemetry project is cloudgrid-system when self-observability is enabled.

Local mode still keeps the same architectural boundary:

  • frontend talks only to the BFF;
  • BFF reads through private services;
  • collector publishes ingest commands;
  • storage services own SurrealDB access.

Deployed SSO Mode

Deployed mode prepares CloudGrid for shared usage:

CLOUDGRID_DEPLOYMENT_MODE=deployed
CLOUDGRID_AUTH_MODE=sso
CLOUDGRID_AUTH_PROVIDERS=github,google,azure
CLOUDGRID_AUTH_COMPANY_ID=acme

The BFF owns browser login, callback, logout, and session cookies. Provider access tokens never reach the frontend. The first SSO user for an empty configured company becomes company admin. Later users need a company invitation accepted through a matching verified SSO email.

Decision Flow

diagram
Yes No Yes No Where will CloudGrid run? Single trusted machine? Use local + local Shared users or network? Use deployed + sso Check production-readiness gaps before public exposure
Mermaid diagram rendered with beautiful-mermaid.

Next Step

For a laptop setup, continue with Local quickstart. For shared mode configuration, start with Deployed configuration.

Last updated .