Skip to content

Environments

CXGear is not a single website process. Several services work together. Knowing which one does what helps when something “does nothing.”

ServiceRole
WebThe UI you use in the browser
APILogin, projects, billing, channels, job creation
RuntimeActually runs spinner jobs (steps, AI, channels)
DatabaseStores orgs, tables, jobs, sessions

If the web and API are up but the runtime is not, you can create projects and click Run now, but jobs will not progress.

Typical local URLs:

PieceURL
Webhttp://localhost:5173
APIhttp://localhost:3000
Docshttp://localhost:4321
Runtimehttp://localhost:3001 (health only; workers poll the DB)

Important environment variables:

VariablePurpose
PUBLIC_API_URLPublic base URL of the API (OAuth redirects, webhooks)
PUBLIC_APP_URLPublic base URL of the web app
META_APP_ID / META_APP_SECRETWhatsApp Meta OAuth
DATABASE_URLPostgres connection

For Meta OAuth in production, PUBLIC_API_URL must be your real HTTPS API host (for example https://api.cxgear.ai), and that host must match the redirect URI in the Meta app.

  • app.cxgear.ai — web UI
  • api.cxgear.ai — API
  • docs.cxgear.ai — this documentation site
  • Runtime workers — one or more processes with DB access