mirror of
https://github.com/lobehub/lobehub
synced 2026-04-21 17:47:27 +00:00
159 lines
5 KiB
Markdown
159 lines
5 KiB
Markdown
# LobeChat Environment Variables
|
|
|
|
LobeChat provides additional configuration options during deployment, which can be set using environment variables
|
|
|
|
#### TOC
|
|
|
|
- [General Variables](#general-variables)
|
|
- [`ACCESS_CODE`](#access_code)
|
|
- [`NEXT_PUBLIC_CUSTOM_MODELS`](#next_public_custom_models)
|
|
- [OpenAI](#openai)
|
|
- [`OPENAI_API_KEY`](#openai_api_key)
|
|
- [`OPENAI_PROXY_URL`](#openai_proxy_url)
|
|
- [Azure OpenAI](#azure-openai)
|
|
- [`USE_AZURE_OPENAI`](#use_azure_openai)
|
|
- [`AZURE_API_KEY`](#azure_api_key)
|
|
- [`AZURE_API_VERSION`](#azure_api_version)
|
|
- [Plugin Service](#plugin-service)
|
|
- [`PLUGINS_INDEX_URL`](#plugins_index_url)
|
|
- [Agent Service](#agent-service)
|
|
- [`AGENTS_INDEX_URL`](#agents_index_url)
|
|
- [Data Analytics](#data-analytics)
|
|
- [Vercel Analytics](#vercel-analytics)
|
|
- [Posthog 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.
|
|
- Default: `-`
|
|
- Example: `awCTe)re_r74` or `rtrt_ewee3@09!`
|
|
|
|
### `NEXT_PUBLIC_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][openai-api-page] 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`
|
|
|
|
<br/>
|
|
|
|
## Azure OpenAI
|
|
|
|
If you need to use Azure OpenAI to provide model services, you can refer to the [Deploy with Azure OpenAI](Deploy-with-Azure-OpenAI.zh-CN.md) 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][azure-api-verion-url]
|
|
|
|
<br/>
|
|
|
|
## 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`
|
|
|
|
<br/>
|
|
|
|
## 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`
|
|
|
|
<br/>
|
|
|
|
## Data Analytics
|
|
|
|
### Vercel Analytics
|
|
|
|
#### `NEXT_PUBLIC_ANALYTICS_VERCEL`
|
|
|
|
- Type: Optional
|
|
- Description: Environment variable to enable [Vercel Analytics][vercel-analytics-url]. 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][posthog-analytics-url]. 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`
|
|
|
|
[azure-api-verion-url]: https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version
|
|
[openai-api-page]: https://platform.openai.com/account/api-keys
|
|
[posthog-analytics-url]: https://posthog.com
|
|
[vercel-analytics-url]: https://vercel.com/analytics
|