The API, proxy, collector and VM runners form BoxLite's cloud platform on AWS or GCP.
The applications under this directory form BoxLite's hosted control plane and runner data plane. This view shows how public traffic reaches private services, how the control plane schedules boxes, and where state and telemetry flow.
Choose the architecture for the stage's declared cloud; neither provider is preferred.
| Cloud | Guide |
|---|---|
| AWS | Architecture and diagrams |
| GCP | Architecture and diagrams |
The infrastructure index links deployment, configuration, runner operations, networking, security, observability and costs. Follow the deployment runbook for the intended cloud and deployment path.
api/README.md— the control-plane API: business events and the operation context that records who asked.runner/README.md— the runner daemon: box lifecycle, execution and attach, files, and metrics.proxy/README.md— the preview proxy: preview hosts, authentication, and tunnels to guest ports.image-service/README.md— the registry proxy: how a runner pulls an image whose registry credentials only the platform holds.
See API.md for the categorized inventory of every application
interface, including its method, path, owning service, and purpose. Alongside
the registered routes it covers outbound events, static asset trees, the local
development stack, and the APIs whose clients live here but whose routes are
served elsewhere.
See SCHEMA.md for the control-plane Postgres schema: every
table with its columns, keys, and indexes, how the tables relate and which of
those relationships the database enforces, and the satellite stores that sit
beside it.