lobehub/docs/Deployment/Environment-Variable.md

Environment Variables

LobeChat provides additional configuration options during deployment, which can be set using environment variables

TOC

• General Variables
  • ACCESS_CODE
  • CUSTOM_MODELS
• OpenAI
  • OPENAI_API_KEY
  • OPENAI_PROXY_URL
• Azure OpenAI
  • USE_AZURE_OPENAI
  • AZURE_API_KEY
  • AZURE_API_VERSION
• Plugin Service
  • PLUGINS_INDEX_URL
• Agent Service
  • AGENTS_INDEX_URL
• Data Analytics
  • Vercel Analytics
  • Posthog Analytics

General Variables

ACCESS_CODE

• Type: Optional
• Description: Add a password to access the LobeChat service, ; you can set a long password to avoid leaking. If this value contains a comma, it is a password array.
• Default: -
• Example: awCTe)re_r74 or rtrt_ewee3@09! or code1,code2,code3

CUSTOM_MODELS

• Type: Optional
• Description: Used to control the model list. Use + to add a model, - to hide a model, and model_name=display_name to customize the display name of a model, separated by commas.
• Default: -
• Example: +qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo

The above example adds qwen-7b-chat and glm-6b to the model list, removes gpt-3.5-turbo from the list, and displays the model name gpt-4-1106-preview as gpt-4-turbo. If you want to disable all models first and then enable specific models, you can use -all,+gpt-3.5-turbo, which means only gpt-3.5-turbo will be enabled.

OpenAI

OPENAI_API_KEY

• Type: Required
• Description: This is the API key you apply for on the OpenAI account page, you can go here to view
• Default: -
• Example: sk-xxxxxx...xxxxxx

OPENAI_PROXY_URL

• Type: Optional
• Description: If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL
• Default: https://api.openai.com
• Example: https://api.chatanywhere.cn

Azure OpenAI

If you need to use Azure OpenAI to provide model services, you can refer to the Deploy with Azure OpenAI section for detailed steps. Here are the environment variables related to Azure OpenAI.

USE_AZURE_OPENAI

• Type: Optional
• Description: Set this value to 1 to enable Azure OpenAI configuration
• Default: -
• Example: 1

AZURE_API_KEY

• Type: Optional
• Description: This is the API key you apply for on the Azure OpenAI account page
• Default: -
• Example: c55168be3874490ef0565d9779ecd5a6

AZURE_API_VERSION

• Type: Optional
• Description: Azure's API version, following the YYYY-MM-DD format
• Default: 2023-08-01-preview
• Example: 2023-05-15, refer to latest version

Plugin Service

PLUGINS_INDEX_URL

• Type: Optional
• Description: The index address of the LobeChat plugin market. If you have deployed the plugin market service yourself, you can use this variable to override the default plugin market address
• Default: https://chat-plugins.lobehub.com

PLUGINS_SETTINGS

• Type: Optional
• Description: Used to set the plugin settings, the format is plugin-identifier:key1=value1;key2=value2, multiple settings fields are separated by semicolons ;, multiple plugin settings are separated by commas ,.
• Default: -
• Example：search-engine:SERPAPI_API_KEY=xxxxx,plugin-2:key1=value1;key2=value2

The above example adds search-engine plugin settings, and sets the SERPAPI_API_KEY of the search-engine plugin to xxxxx, and sets the key1 of the plugin-2 plugin to value1, and key2 to value2. The generated plugin settings configuration is as follows:

{
  "plugin-2": {
    "key1": "value1",
    "key2": "value2"
  },
  "search-engine": {
    "SERPAPI_API_KEY": "xxxxx"
  }
}

Agent Service

AGENTS_INDEX_URL

• Type: Optional
• Description: The index address of the LobeChat role market. If you have deployed the role market service yourself, you can use this variable to override the default plugin market address
• Default: https://chat-agents.lobehub.com

Data Analytics

Vercel Analytics

NEXT_PUBLIC_ANALYTICS_VERCEL

• Type: Optional
• Description: Environment variable to enable Vercel Analytics. Set to 1 to enable Vercel Analytics.
• Default: -
• Example: 1

NEXT_PUBLIC_VERCEL_DEBUG

• Type: Optional
• Description: Enable debug mode for Vercel Analytics.
• Default: -
• Example: 1

Posthog Analytics

NEXT_PUBLIC_ANALYTICS_POSTHOG

• Type: Optional
• Description: Environment variable to enable PostHog Analytics. Set to 1 to enable PostHog Analytics.
• Default: -
• Example: 1

NEXT_PUBLIC_POSTHOG_KEY

• Type: Optional
• Description: Set the PostHog project key.
• Default: -
• Example: phc_xxxxxxxx

NEXT_PUBLIC_POSTHOG_HOST

• Type: Optional
• Description: Set the deployment address of the PostHog service. Default is the official SAAS address.
• Default: https://app.posthog.com
• Example: https://example.com

NEXT_PUBLIC_POSTHOG_DEBUG

• Type: Optional
• Description: Enable debug mode for PostHog.
• Default: -
• Example: 1