Skip to main content
Version: dev

Environment Variables

Reference for commonly used environment variables in DB-GPT.

tip

Most configuration is done through TOML config files. Environment variables are useful for secrets, Docker deployments, and overriding defaults.

Model configuration​

VariableDescriptionExample
OPENAI_API_KEYOpenAI API keysk-...
OPENAI_API_BASEOpenAI-compatible API base URLhttps://api.openai.com/v1
DEEPSEEK_API_KEYDeepSeek API keysk-...
SILICONFLOW_API_KEYSiliconFlow API keysk-...
DASHSCOPE_API_KEYAlibaba Cloud DashScope API keysk-...
AIMLAPI_API_KEYAI/ML API key—
LLM_MODELDefault LLM model name (cluster mode)glm-4-9b-chat
MODEL_SERVERModel controller address (cluster mode)http://127.0.0.1:8000

Server configuration​

VariableDescriptionDefault
DBGPT_LOG_LEVELLogging levelINFO
LOCAL_DB_TYPEMetadata database typesqlite
LOCAL_DB_PATHSQLite database pathdata/default_sqlite.db
MYSQL_HOSTMySQL host127.0.0.1
MYSQL_PORTMySQL port3306
MYSQL_USERMySQL usernameroot
MYSQL_PASSWORDMySQL password—
MYSQL_DATABASEMySQL database namedbgpt

GPU and hardware​

VariableDescriptionExample
CUDA_VISIBLE_DEVICESRestrict which GPUs are visible0,1
DEVICEForce device typecuda, cpu, mps

Network and proxy​

VariableDescriptionExample
UV_INDEX_URLPyPI mirror for uvhttps://pypi.tuna.tsinghua.edu.cn/simple
HTTP_PROXYHTTP proxy for outbound requestshttp://proxy:8080
HTTPS_PROXYHTTPS proxy for outbound requestshttp://proxy:8080
NO_PROXYHosts to bypass proxylocalhost,127.0.0.1

Using environment variables in TOML configs​

DB-GPT supports environment variable substitution in TOML config files:

[[models.llms]]
api_key = "${env:OPENAI_API_KEY}"

[[models.embeddings]]
api_key = "${env:OPENAI_API_KEY:-default-key}"

Syntax:

PatternBehavior
${env:VAR_NAME}Read from environment variable (error if missing)
${env:VAR_NAME:-default}Read from environment, use default if not set

Docker environment variables​

When running with Docker, pass environment variables with -e:

docker run -it --rm \
-e SILICONFLOW_API_KEY=your-key \
-e DBGPT_LOG_LEVEL=DEBUG \
-p 5670:5670 \
eosphorosai/dbgpt-openai

Or with Docker Compose in docker-compose.yml:

services:
webserver:
environment:
- SILICONFLOW_API_KEY=${SILICONFLOW_API_KEY}
- DBGPT_LOG_LEVEL=INFO

Next steps​

TopicLink
Full config referenceConfig Reference
Model providersProviders
Troubleshooting indexTroubleshooting