Reference

Lookup material — schemas, variables, paths, and release information. These pages are the authoritative source when a guide and a reference page disagree.

Architecture Folder structure Third-party services Crash reporting config.json options Dynamic compose Breaking updates Environment variables Download Companion Hub

What each page covers

Page	What it covers
Architecture	How the Hub stack and platform components fit together
Folder structure	Every directory under your Hub data root, and what lives outside it
Third-party services	External services Hub can talk to, and what is never collected
Crash reporting	Exactly what a crash report contains, what is stripped, and how to turn it off
config.json options	The full app manifest schema
Dynamic compose	The `docker-compose.json` schema, with a live validator
Breaking updates	Migrations and renamed settings
Environment variables	The variables you may need to set or read, including legacy names

How the pieces fit together

Most reference pages describe one input to, or output of, a running Hub. The app manifest and compose schema arrive from CI Cloud’s app catalog, the env file and settings.json configure the stack, and the folder structure is where the results land:

flowchart TD
    C["CI Cloud app catalog<br/>hub.ci.computer"] -->|"config.json +<br/>docker-compose.json"| H["Companion Hub"]
    E["Env file and settings.json<br/>environment variables and settings"] -->|"configure the stack"| H
    H -->|"installs into"| A["apps/ and app-data/<br/>folder structure"]
    H -->|"outbound connections"| T["Registries, CI Cloud, Let's Encrypt,<br/>Cloudflare, Tailscale, Sentry<br/>third-party services"]

Breaking updates sits across all of these: it lists the legacy manifest fields, variables, and file names that are still accepted.