Guide to configuring LobeChat for your deployment needs.
| Variable | Default | Description | Required |
|---|---|---|---|
KEY_VAULTS_SECRET |
- |
Encrypts sensitive data. Use a long, random string. Once set, do not change it or encrypted data cannot be decrypted. | Recommended |
API_KEY_SELECT_MODE |
random |
API Key selection mode: random (select randomly) or turn (poll in order) |
Optional |
DEFAULT_AGENT_CONFIG |
- |
Default agent configuration. Format: model=gpt-4-1106-preview;params.max_tokens=300;plugins=search-engine |
Optional |
SYSTEM_AGENT |
- |
System agent configuration. Format: default=provider/model or agent-name=provider/model |
Optional |
FEATURE_FLAGS |
- |
Control features. Use + to enable, - to disable. Example: "-welcome_suggest" |
Optional |
PROXY_URL |
- |
Proxy URL for external services. Example: http://127.0.0.1:7890 |
Optional |
ENABLE_PROXY_DNS |
0 |
Send DNS queries through proxy. 0 = resolve locally, 1 = send to proxy |
Optional |
SSRF_ALLOW_PRIVATE_IP_ADDRESS |
0 |
Allow private IP connections. 0 = block, 1 = allow (trusted environments only) |
Optional |
SSRF_ALLOW_IP_ADDRESS_LIST |
- |
Whitelist of allowed IPs (comma-separated) | Optional |
NEXT_PUBLIC_BASE_PATH |
- |
Base path for static resources. Example: /lobechat or https://cdn.example.com |
Optional |
| Variable | Default | Description | Required |
|---|---|---|---|
AI_IMAGE_DEFAULT_IMAGE_NUM |
4 |
Default number of images to generate (1-20) | Optional |
| Variable | Default | Description | Required |
|---|---|---|---|
PLUGINS_INDEX_URL |
https://chat-plugins.lobehub.com |
Plugin marketplace index URL | Optional |
PLUGIN_SETTINGS |
- |
Plugin settings. Format: plugin-name:setting=value;key2=value2 |
Optional |
| Variable | Default | Description | Required |
|---|---|---|---|
AGENTS_INDEX_URL |
https://chat-agents.lobehub.com |
Assistant marketplace index URL | Optional |
| Variable | Description | Required |
|---|---|---|
OPENAI_API_KEY |
Your OpenAI API key | Yes (for OpenAI) |
OPENAI_PROXY_URL |
Custom OpenAI API endpoint | Optional |
OPENAI_MODEL_LIST |
Custom model list. Use + to show, - to hide. Example: +gpt-4,-gpt-3.5-turbo |
Optional |
Configure additional model providers through the UI or environment variables specific to each provider.
| Variable | Description | Required |
|---|---|---|
DATABASE_URL |
PostgreSQL connection string. Format: postgresql://user:password@host:5432/database |
For multi-user mode |
| Variable | Description | Required |
|---|---|---|
NEXT_AUTH_SECRET |
NextAuth secret key for session encryption | For auth |
NEXTAUTH_URL |
Your application URL. Example: https://chat.example.com |
For auth |
Control which models are available:
# Show GPT-4, hide GPT-3.5
OPENAI_MODEL_LIST=+gpt-4,-gpt-3.5-turbo
# Multiple models
OPENAI_MODEL_LIST=+gpt-4,+gpt-4-turbo,-gpt-3.5-turbo-instruct
# Custom display names
OPENAI_MODEL_LIST=gpt-4=My GPT-4,gpt-3.5-turbo=Fast Model
Configure which models handle system tasks:
# Default model for all system agents
SYSTEM_AGENT=default=openai/gpt-4-1106-preview
# Specific agents
SYSTEM_AGENT=topic=openai/gpt-4-1106-preview,translation=anthropic/claude-3
Available system agents:
default - Default agenttopic - Topic generationtranslation - Translation tasksagentMeta - Agent metadatahistory - Conversation historyqueryRewrite - Query optimizationthread - Thread management# Single plugin
PLUGIN_SETTINGS=search-engine:SERPAPI_API_KEY=your-key
# Multiple plugins
PLUGIN_SETTINGS=search-engine:SERPAPI_API_KEY=key1;REGION=us,image-gen:API_KEY=key2
# Multiple plugin groups
PLUGIN_SETTINGS="plugin1:key1=value1;key2=value2,plugin2:key3=value3"
Enable or disable specific features:
# Disable welcome suggestions
FEATURE_FLAGS="-welcome_suggest"
# Multiple flags
FEATURE_FLAGS="-welcome_suggest,+beta_features,-analytics"
# Block all private IPs (recommended for untrusted environments)
SSRF_ALLOW_PRIVATE_IP_ADDRESS=0
# Allow specific IPs only
SSRF_ALLOW_IP_ADDRESS_LIST=192.168.1.100,10.0.0.50
# Allow all private IPs (trusted environments only)
SSRF_ALLOW_PRIVATE_IP_ADDRESS=1
# HTTP proxy
PROXY_URL=http://127.0.0.1:7890
# SOCKS5 proxy
PROXY_URL=socks5://localhost:7891
# For Docker Desktop, use host.docker.internal
PROXY_URL=http://host.docker.internal:7890
# Route DNS through proxy
ENABLE_PROXY_DNS=1
Configure the default agent behavior:
# Basic configuration
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview
# With parameters
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview;params.max_tokens=300;params.temperature=0.7
# With plugins
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview;plugins=search-engine,lobe-image-designer
# Full configuration
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview;params.max_tokens=500;params.temperature=0.7;plugins=search-engine,wolfram-alpha
# Set base path
NEXT_PUBLIC_BASE_PATH=/lobechat
# Configure domain
NEXTAUTH_URL=https://your-domain.vercel.app
# All configuration in docker-compose.yml
environment:
- OPENAI_API_KEY=sk-...
- KEY_VAULTS_SECRET=your-secret-key
- DATABASE_URL=postgresql://user:pass@db:5432/lobechat
- SSRF_ALLOW_PRIVATE_IP_ADDRESS=0
env:
- name: OPENAI_API_KEY
valueFrom:
secretKeyRef:
name: lobechat-secrets
key: openai-api-key
- name: KEY_VAULTS_SECRET
valueFrom:
secretKeyRef:
name: lobechat-secrets
key: vault-secret
OPENAI_API_KEY=sk-your-key
# API Keys
OPENAI_API_KEY=sk-your-key
# Security
KEY_VAULTS_SECRET=your-long-random-secret-key-here
# Features
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview;params.max_tokens=500
FEATURE_FLAGS="-welcome_suggest"
# API Keys
OPENAI_API_KEY=sk-your-key
API_KEY_SELECT_MODE=turn
# Database
DATABASE_URL=postgresql://lobechat:secure-password@db:5432/lobechat
# Security
KEY_VAULTS_SECRET=your-very-long-random-secret-key
SSRF_ALLOW_PRIVATE_IP_ADDRESS=0
# Authentication
NEXT_AUTH_SECRET=your-nextauth-secret
NEXTAUTH_URL=https://chat.example.com
# Features
DEFAULT_AGENT_CONFIG=model=gpt-4-1106-preview;params.max_tokens=500;plugins=search-engine
PLUGINS_INDEX_URL=https://your-plugin-market.com
After configuration changes:
# Restart container
docker compose restart lobe-chat
# Check logs
docker compose logs -f lobe-chat
# Verify environment variables
docker compose exec lobe-chat env | grep OPENAI
Any questions?
Feel free to contact us. Find all contact information on our contact page.