Skip to main content

Environment Variables

Complete reference of environment variables used across the Subscriberbot ecosystem.

Primary selector

VariableValuesDefaultDescription
BURDENOFF_ENVlocal | alpha | prodprodSelects the target environment for all tooling. Read at runtime (CLI, SDK, app) or build time (browser extension).

CLI

VariableDefaultDescription
SUBSCRIBERBOT_WORKSPACE_ENDPOINTDerived from BURDENOFF_ENVWorkspace gateway GraphQL endpoint
SUBSCRIBERBOT_GLOBAL_ENDPOINTDerived from BURDENOFF_ENVGlobal gateway GraphQL endpoint
SUBSCRIBERBOT_OIDC_ISSUERDerived from BURDENOFF_ENVOIDC issuer URL
SUBSCRIBERBOT_CLIENT_IDburdenoff_cli_subscriberbotOAuth2 client id
SUBSCRIBERBOT_CLIENT_SECRETOAuth2 client secret (client credentials flow)

Node SDK

VariableDefaultDescription
SUBSCRIBERBOT_WORKSPACE_ENDPOINTWorkspace gateway GraphQL endpoint (constructor takes precedence)
SUBSCRIBERBOT_GLOBAL_ENDPOINTGlobal gateway GraphQL endpoint (constructor takes precedence)
SUBSCRIBERBOT_API_KEYAPI key authentication
SUBSCRIBERBOT_ACCESS_TOKENPre-existing access token
SUBSCRIBERBOT_REFRESH_TOKENPre-existing refresh token
SUBSCRIBERBOT_WORKSPACE_TOKENPre-existing workspace token

Python SDK

VariableDefaultDescription
SUBSCRIBERBOT_WORKSPACE_ENDPOINTWorkspace gateway GraphQL endpoint (constructor takes precedence)
SUBSCRIBERBOT_GLOBAL_ENDPOINTGlobal gateway GraphQL endpoint (constructor takes precedence)

MCP Server

VariableDefaultDescription
SUBSCRIBERBOT_WORKSPACE_ENDPOINThttps://graphqlworkspaces.burdenoff.com/workspaces/graphqlWorkspace gateway
SUBSCRIBERBOT_GLOBAL_ENDPOINThttps://graphql.burdenoff.com/global/graphqlGlobal gateway
SUBSCRIBERBOT_API_KEYAPI key auth (skips device code)
SUBSCRIBERBOT_ACCESS_TOKENPre-set access token
SUBSCRIBERBOT_WORKSPACE_IDPre-select workspace
SUBSCRIBERBOT_ORGANIZATION_IDPre-select organization
LOG_LEVELinfoLogging level (error/warn/info/debug)

Browser Extension (build time)

VariableDefaultDescription
BURDENOFF_ENVprodSelects endpoints baked into the webpack bundle

VS Code Extension (runtime)

VariableDefaultDescription
BURDENOFF_ENVprodResolved at VS Code launch time in src/env.ts

App Shell (build time)

VariableDefaultDescription
BURDENOFF_ENVprodSelects gateway base URLs baked into Vite build
VITE_WSPACE_GATEWAY_URLDerived from BURDENOFF_ENVWorkspace gateway base URL (no path)
VITE_GLOBAL_GATEWAY_URLDerived from BURDENOFF_ENVGlobal gateway base URL (no path)

Doctor E2E

VariableDefaultDescription
SUBSCRIBERBOT_TARGETprodTarget environment: prod, alpha, local
SUBSCRIBERBOT_ENDPOINTDirect endpoint override (takes precedence)
AUTH_TOKENPlatform JWT for alpha/prod runs
WORKSPACE_TOKENWorkspace JWT for alpha/prod runs
WORKSPACE_IDWorkspace UUID for alpha/prod runs
USER_IDUser UUID for alpha/prod runs
CF_ACCESS_CLIENT_IDCloudflare Access client id (alpha only)
CF_ACCESS_CLIENT_SECRETCloudflare Access client secret (alpha only)

Backend Service (local dev)

VariableDefaultDescription
DATABASE_URLPostgreSQL connection string
REDIS_URLValkey/Redis connection string
PORT3291HTTP server port
HIVE_TOKENGraphQL Hive CLI token

Endpoint defaults by environment

EnvironmentWorkspace gatewayGlobal gatewayOIDC issuer
prodhttps://graphqlworkspaces.burdenoff.com/workspaces/graphqlhttps://graphql.burdenoff.com/global/graphqlhttps://graphql.burdenoff.com/global
alphahttps://alphagraphqlworkspaces.burdenoff.com/workspaces/graphqlhttps://alphagraphql.burdenoff.com/global/graphqlhttps://alphagraphql.burdenoff.com/global
localhttp://localhost:4003/workspaces/graphqlhttp://localhost:4000/global/graphqlhttp://localhost:4000/global