Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Each Observatory service reads its configuration from environment variables. This page lists the variables grouped by service. Defaults shown are what the standard Docker Compose stack uses.

Observatory API

Database

Environment VariableDescriptionDefault ValueComponent
POSTGRES_OBSERVATORY_URIPostgreSQL host and port.observatory-db:5432observatory-api
POSTGRES_OBSERVATORY_DATABASEDatabase name.observatoryobservatory-api
POSTGRES_OBSERVATORY_USERNAMEDatabase username.observatoryobservatory-api
POSTGRES_OBSERVATORY_PASSWORDDatabase password.S3cretobservatory-api

Authentication (Keycloak)

Environment VariableDescriptionDefault ValueComponent
SECURITY_OAUTH2_BASE_SERVER_URLBase URL of the auth server.(set per env)observatory-api
SECURITY_OAUTH2_REALMRealm name (the organization ID).(set per env)observatory-api
SECURITY_OAUTH2_CLIENT_IDOAuth2 client ID.flowx-platform-authenticateobservatory-api
SECURITY_OAUTH2_CLIENT_SECRETClient secret.(set per env)observatory-api
Observatory authenticates against an external FlowX identity provider — the platform does not bundle its own Keycloak. Point these at your auth server; the realm is your organization ID.

LLM providers

Environment VariableDescriptionDefault ValueComponent
OPENAI_API_KEYOpenAI API key.(required for OpenAI)observatory-api
ANTHROPIC_API_KEYAnthropic API key.(optional)observatory-api
GOOGLE_API_KEYGoogle API key.(optional)observatory-api
XAI_API_KEYxAI API key.(optional)observatory-api
MISTRAL_API_KEYMistral API key.(optional)observatory-api
OLLAMA_BASE_URLLocal Ollama URL.http://host.docker.internal:11434observatory-api

Operational

Environment VariableDescriptionDefault ValueComponent
URL_PREFIXPath prefix the API is served under./ai-observatoryobservatory-api
CACHE_SIZEIn-memory cache size (entries).1000observatory-api
CACHE_TTLCache TTL in seconds.3600observatory-api
GUNICORN_WORKERSWorker processes.1observatory-api
GUNICORN_TIMEOUTWorker timeout in seconds.600observatory-api
APPLICATION_CORS_ALLOW_ORIGINComma-separated list of allowed CORS origins.(set per env)observatory-api

Observatory Web

Environment VariableDescriptionDefault ValueComponent
BASE_API_URLBase URL of observatory-api.http://localhost:8091observatory-web
PLATFORM_API_URLBase URL of observatory-platform.http://localhost:8092observatory-web
KEYCLOAK_ISSUEROIDC issuer URL (auth server + realm).(set per env)observatory-web
KEYCLOAK_REDIRECT_URIPost-login redirect.http://localhost:4900observatory-web
KEYCLOAK_CLIENT_IDPublic client ID.flowx-platform-authenticateobservatory-web
KEYCLOAK_SCOPESOAuth2 scopes.openid profile email offline_accessobservatory-web

Observatory Platform

Environment VariableDescriptionDefault ValueComponent
LOG_LEVELLogger level.INFOobservatory-platform
PROMETHEUS_ENABLEDToggle Prometheus metrics.falseobservatory-platform
ALLOWED_ORIGINSComma-separated list of allowed CORS origins.(set per env)observatory-platform

Observatory SDK

Set these in the environment of the app that uses the SDK — not on the platform itself:
Environment VariableDescriptionDefault Value
FLOWX_OBSERVATORY_API_KEYAPI key from the Observatory Home page.(required)
FLOWX_OBSERVATORY_API_URLBase URL of the Observatory API.(required)
FLOWX_OBSERVATORY_ORG_IDOrganization ID.(required)
FLOWX_OBSERVATORY_WORKSPACE_IDWorkspace ID.(required)
FLOWX_OBSERVATORY_APP_IDProject ID.(required)
OBSERVATORY_TRACINGSet to false to turn off instrumentation.true

PostgreSQL initialization

The default database setup creates these databases via init_dbs/multiple-databases.sh (POSTGRES_MULTIPLE_DATABASES):
  • observatory — the main API store
  • dip, writer, agent_history, builder, insights, maildb — companion services in the FlowX AI stack
Default local credentials: observatory / S3cret. Override via the POSTGRES_OBSERVATORY_* env vars in production.

Self-hosted setup

The Compose flow that consumes these variables.

SDK overview

SDK-side environment configuration.
Last modified on June 2, 2026