@lobehub/chat 0.128.1 → 0.128.3

package/docs/self-hosting/environment-variable.mdx

@@ -0,0 +1,340 @@
+```markdown
+import { Callout } from 'nextra/components';
+
+# Environment Variables
+
+LobeChat provides some additional configuration options during deployment, which can be customized using environment variables.
+
+## Common Variables
+
+### `ACCESS_CODE`
+
+- Type: Optional
+- Description: Add a password to access the LobeChat service. You can set a long password to prevent brute force attacks.
+- Default: -
+- Example: `awCTe)re_r74` or `rtrt_ewee3@09!`
+
+### `ENABLE_OAUTH_SSO`
+
+- Type: Optional
+- Description: Enable Single Sign-On (SSO) for LobeChat. Set to `1` to enable SSO. For more information, see [Authentication Services](#authentication-services).
+- Default: -
+- Example: `1`
+
+### `NEXT_PUBLIC_BASE_PATH`
+
+- Type: Optional
+- Description: Add a `basePath` for LobeChat.
+- Default: -
+- Example: `/test`
+
+### `DEFAULT_AGENT_CONFIG`
+
+- Type: Optional
+- Description: Used to configure the default settings for the LobeChat default assistant. It supports various data types and structures, including key-value pairs, nested fields, array values, etc.
+- Default: -
+- Example: `'model=gpt-4-1106-preview;params.max_tokens=300;plugins=search-engine,lobe-image-designer`
+
+`DEFAULT_AGENT_CONFIG` is used to configure the default settings for the LobeChat default assistant. It supports various data types and structures, including key-value pairs, nested fields, array values, etc. The table below provides detailed information on the configuration options, examples, and corresponding explanations for the `DEFAULT_AGENT_CONFIG` environment variable:
+
+| Configuration Type | Example                                      | Explanation                                              |
+| ------------------- | -------------------------------------------- | -------------------------------------------------------- |
+| Basic Key-Value Pair| `model=gpt-4`                                | Set the model to `gpt-4`.                                 |
+| Nested Field        | `tts.sttLocale=en-US`                        | Set the language locale for the text-to-speech service to `en-US`. |
+| Array               | `plugins=search-engine,lobe-image-designer`  | Enable the `search-engine` and `lobe-image-designer` plugins. |
+| Chinese Comma       | `plugins=search-engine，lobe-image-designer`  | Same as above, demonstrating support for Chinese comma separation. |
+| Multiple Configurations | `model=glm-4;provider=zhipu`              | Set the model to `glm-4` and the model provider to `zhipu`. |
+| Numeric Value       | `params.max_tokens=300`                      | Set the maximum tokens to `300`.                           |
+| Boolean Value       | `enableAutoCreateTopic=true`                 | Enable automatic topic creation.                           |
+| Special Characters  | `inputTemplate="Hello; I am a bot;"`         | Set the input template to `Hello; I am a bot;`.            |
+| Error Handling      | `model=gpt-4;maxToken`                       | Ignore invalid entry `maxToken` and only parse `model=gpt-4`. |
+| Value Override      | `model=gpt-4;model=gpt-4-1106-preview`       | If the key is repeated, use the value that appears last, in this case, the value of `model` is `gpt-4-1106-preview`. |
+
+Further Reading:
+
+- [\[RFC\] 022 - Environment Variable Configuration for Default Assistant Parameters](https://github.com/lobehub/lobe-chat/discussions/913)
+```
+
+## Identity Verification Service
+
+### General Settings
+
+#### `ENABLE_OAUTH_SSO`
+
+- Type: Required
+- Description: Enable Single Sign-On (SSO) for LobeChat. Set to `1` to enable single sign-on.
+- Default: `-`
+- Example: `1`
+
+#### `NEXTAUTH_SECRET`
+
+- Type: Required
+- Description: Key used to encrypt the session tokens in Auth.js. You can generate the key using the following command: `openssl rand -base64 32`.
+- Default: `-`
+- Example: `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`
+
+### Auth0
+
+<Callout>
+  Currently, we only support the Auth0 identity verification service provider. If you need to use another identity verification service provider, you can submit a [feature request](https://github.com/lobehub/lobe-chat/issues/new/choose) or a pull request.
+</Callout>
+
+#### `AUTH0_CLIENT_ID`
+
+- Type: Required
+- Description: Client ID of the Auth0 application. You can access it [here][auth0-client-page] and navigate to the application settings to view.
+- Default: `-`
+- Example: `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`
+
+#### `AUTH0_CLIENT_SECRET`
+
+- Type: Required
+- Description: Client Secret of the Auth0 application.
+- Default: `-`
+- Example: `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm`
+
+#### `AUTH0_ISSUER`
+
+- Type: Required
+- Description: Issuer/domain of the Auth0 application.
+- Default: `-`
+- Example: `https://example.auth0.com`
+
+## Model Service Provider
+
+### OpenAI
+
+#### `OPENAI_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for on the OpenAI account page, you can go to [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/v1`
+- Example: `https://api.chatanywhere.cn` or `https://aihubmix.com/v1`
+
+\<Callout type={'warning'}>
+Please check the request suffix of your proxy service provider. Some proxy service providers may add `/v1` to the request suffix, while others may not. If you find that the AI returns an empty message during testing, try adding the `/v1` suffix and retry. </Callout>
+
+\<Callout type={'info'}>
+Whether to fill in `/v1` is closely related to the model service provider. For example, the default address of openai is `api.openai.com/v1`. If your proxy forwards the `/v1` interface, you can simply fill in `proxy.com`. However, if the model service provider directly forwards the `api.openai.com` domain, then you need to add `/v1` to the URL yourself. </Callout>
+
+Related discussions:
+
+- [Why is the return value blank after installing Docker, configuring the environment variables?](https://github.com/lobehub/lobe-chat/discussions/623)
+- [Reasons for errors using third-party interfaces](https://github.com/lobehub/lobe-chat/discussions/734)
+- [No response when the proxy server address is filled in for chatting](https://github.com/lobehub/lobe-chat/discussions/1065)
+
+#### `CUSTOM_MODELS`
+
+- Type: Optional
+- Description: Used to control the model list, use `+` to add a model, use `-` to hide a model, use `model name=display name` to customize the display name of a model, separated by English commas.
+- Default: `-`
+- Example: `+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-0125-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 of `gpt-4-0125-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` is enabled.
+
+You can find all current model names in [modelProviders](https://github.com/lobehub/lobe-chat/tree/main/src/config/modelProviders).
+
+### Azure OpenAI
+
+If you need to use Azure OpenAI to provide model services, you can refer to the [Deploying with Azure OpenAI](../Deployment/Deploy-with-Azure-OpenAI.en-US.md) section for detailed steps. Here, we will list 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 applied for on the Azure OpenAI account page
+- Default: -
+- Example: `c55168be3874490ef0565d9779ecd5a6`
+
+#### `AZURE_API_VERSION`
+
+- Type: Optional
+- Description: The API version of Azure, following the format YYYY-MM-DD
+- Default: `2023-08-01-preview`
+- Example: `2023-05-15`, refer to the [latest version][azure-api-verion-url]
+
+### ZHIPU AI
+
+#### `ZHIPU_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for in the ZHIPU AI service
+- Default: -
+- Example: `4582d332441a313f5c2ed9824d1798ca.rC8EcTAhgbOuAuVT`
+
+### Moonshot AI
+
+#### `MOONSHOT_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for in the Moonshot AI service
+- Default: -
+- Example: `Y2xpdGhpMzNhZXNoYjVtdnZjMWc6bXNrLWIxQlk3aDNPaXpBWnc0V1RaMDhSRmRFVlpZUWY=`
+
+### Google AI
+
+#### `GOOGLE_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for in the Google AI Platform to access Google AI services
+- Default: -
+- Example: `AIraDyDwcw254kwJaGjI9wwaHcdDCS__Vt3xQE`
+
+### AWS Bedrock
+
+#### `AWS_ACCESS_KEY_ID`
+
+- Type: Required
+- Description: Access key ID for AWS service authentication
+- Default: -
+- Example: `AKIA5STVRLFSB4S9HWBR`
+
+#### `AWS_SECRET_ACCESS_KEY`
+
+- Type: Required
+- Description: Secret key for AWS service authentication
+- Default: -
+- Example: `Th3vXxLYpuKcv2BARktPSTPxx+jbSiFT6/0w7oEC`
+
+#### `AWS_REGION`
+
+- Type: Optional
+- Description: Region setting for AWS services
+- Default: `us-east-1`
+- Example: `us-east-1`
+
+### Ollama
+
+#### `OLLAMA_PROXY_URL`
+
+- Type: Optional
+- Description: Used to enable the Ollama service, setting this will display optional open-source language models in the language model list and can also specify custom language models
+- Default: -
+- Example: `http://127.0.0.1:11434/v1`
+
+## Plugin Service
+
+### `PLUGINS_INDEX_URL`
+
+- Type: Optional
+- Description: The index address of the LobeChat plugin market. If you have deployed the plugin market service on your own, you can use this variable to override the default plugin market address.
+- Default Value: `https://chat-plugins.lobehub.com`
+
+### `PLUGIN_SETTINGS`
+
+- Type: Optional
+- Description: Used to configure plugin settings. Use the format `plugin_name:setting_field=setting_value` to configure the plugin settings. Multiple setting fields are separated by an English semicolon `;`, and multiple plugin settings are separated by an English comma `,`.
+- Default Value: `-`
+- Example: `search-engine:SERPAPI_API_KEY=xxxxx,plugin-2:key1=value1;key2=value2`
+
+The above example sets the `SERPAPI_API_KEY` of the `search-engine` plugin to `xxxxx`, and sets `key1` of `plugin-2` to `value1`, and `key2` to `value2`. The generated plugin settings configuration is as follows:
+
+```json
+{
+  "plugin-2": {
+    "key1": "value1",
+    "key2": "value2"
+  },
+  "search-engine": {
+    "SERPAPI_API_KEY": "xxxxx"
+  }
+}
+```
+
+## Assistant Market
+
+### `AGENTS_INDEX_URL`
+
+- Type: Optional
+- Description: The index address of the LobeChat assistant market. If you have deployed the assistant market service on your own, you can use this variable to override the default market address.
+- Default Value: `https://chat-agents.lobehub.com`
+
+## Data Analytics
+
+### Vercel Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_VERCEL`
+
+- Type: Optional
+- Description: Used to configure the environment variables for Vercel Analytics. Set to `1` to enable Vercel Analytics.
+- Default Value: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_VERCEL_DEBUG`
+
+- Type: Optional
+- Description: Used to enable the debug mode for Vercel Analytics.
+- Default Value: `-`
+- Example: `1`
+
+### Posthog Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_POSTHOG`
+
+- Type: Optional
+- Description: Used to enable the environment variables for [PostHog Analytics][posthog-analytics-url]. Set to `1` to enable PostHog Analytics.
+- Default Value: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_POSTHOG_KEY`
+
+- Type: Optional
+- Description: Set the PostHog project key.
+- Default Value: `-`
+- Example: `phc_xxxxxxxx`
+
+#### `NEXT_PUBLIC_POSTHOG_HOST`
+
+- Type: Optional
+- Description: Set the deployment address of the PostHog service, defaulting to the official SAAS address.
+- Default Value: `https://app.posthog.com`
+- Example: `https://example.com`
+
+#### `NEXT_PUBLIC_POSTHOG_DEBUG`
+
+- Type: Optional
+- Description: Enable the debug mode for PostHog.
+- Default Value: `-`
+- Example: `1`
+
+### Umami Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_UMAMI`
+
+- Type: Optional
+- Description: Used to enable the environment variables for [Umami Analytics][umami-analytics-url]. Set to `1` to enable Umami Analytics.
+- Default Value: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_UMAMI_SCRIPT_URL`
+
+- Type: Optional
+- Description: The URL of the Umami script, defaulting to the script URL provided by Umami Cloud.
+- Default Value: `https://analytics.umami.is/script.js`
+- Example: `https://umami.your-site.com/script.js`
+
+#### `NEXT_PUBLIC_UMAMI_WEBSITE_ID`
+
+- Type: Required
+- Description: Your Umami Website ID.
+- Default Value: `-`
+- Example: `E738D82A-EE9E-4806-A81F-0CA3CAE57F65`
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
+[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
+[umami-analytics-url]: https://umami.is

package/docs/{Deployment/Environment-Variable.zh-CN.md → self-hosting/environment-variable.zh-CN.mdx}

@@ -1,33 +1,8 @@
+import { Callout } from 'nextra/components';
+
 # 环境变量
 
-LobeChat 在部署时提供了一些额外的配置项，使用环境变量进行设置
-
-#### TOC
-
-- [通用变量](#通用变量)
-  - [`ACCESS_CODE`](#access_code)
-  - [`ENABLE_OAUTH_SSO`](#enable_oauth_sso)
-  - [`NEXT_PUBLIC_BASE_PATH`](#next_public_base_path)
-- [身份验证服务](#身份验证服务)
-  - [通用设置](#通用设置)
-  - [Auth0](#auth0)
-- [模型服务商](#模型服务商)
-  - [OpenAI](#openai)
-  - [Azure OpenAI](#azure-openai)
-  - [智谱 AI](#智谱-ai)
-  - [Moonshot AI](#moonshot-ai)
-  - [Google AI](#google-ai)
-  - [AWS Bedrock](#aws-bedrock)
-  - [Ollama](#ollama)
-- [插件服务](#插件服务)
-  - [`PLUGINS_INDEX_URL`](#plugins_index_url)
-  - [`PLUGIN_SETTINGS`](#plugin_settings)
-- [角色服务](#角色服务)
-  - [`AGENTS_INDEX_URL`](#agents_index_url)
-- [数据统计](#数据统计)
-  - [Vercel Analytics](#vercel-analytics)
-  - [Posthog Analytics](#posthog-analytics)
-  - [Umami Analytics](#umami-analytics)
+LobeChat 在部署时提供了一些额外的配置项，你可以使用环境变量进行自定义设置。
 
 ## 通用变量
 
@@ -61,18 +36,18 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 
 `DEFAULT_AGENT_CONFIG` 用于配置 LobeChat 默认助理的默认配置。它支持多种数据类型和结构，包括键值对、嵌套字段、数组值等。下表详细说明了 `DEFAULT_AGENT_CONFIG` 环境变量的配置项、示例以及相应解释：
 
-| 配置项类型 | 示例                                         | 解释                                                                         |
-| ---------- | -------------------------------------------- | ---------------------------------------------------------------------------- |
-| 基本键值对 | `model=gpt-4`                                | 设置模型为 `gpt-4`。                                                         |
-| 嵌套字段   | `tts.sttLocale=en-US`                        | 设置文本到语音服务的语言区域为 `en-US`。                                     |
-| 数组       | `plugins=search-engine,lobe-image-designer`  | 启用 `search-engine` 和 `lobe-image-designer` 插件。                         |
-| 中文逗号   | `plugins=search-engine，lobe-image-designer` | 同上，演示支持中文逗号分隔。                                                 |
-| 多个配置项 | `model=glm-4;provider=zhipu`                 | 设置模型为 `glm-4` 且模型服务商为 `zhipu`。                                  |
-| 数字值     | `params.max_tokens=300`                      | 设置最大令牌数为 `300`。                                                     |
-| 布尔值     | `enableAutoCreateTopic=true`                 | 启用自动创建主题。                                                           |
-| 特殊字符   | `inputTemplate="Hello; I am a bot;"`         | 设置输入模板为 `Hello; I am a bot;`。                                        |
-| 错误处理   | `model=gpt-4;maxToken`                       | 忽略无效条目 `maxToken`，仅解析出 `model=gpt-4`。                            |
-| 值覆盖     | `model=gpt-4;model=gpt-4-1106-preview`       | 如果键重复，使用最后一次出现的值，此处 `model` 的值为 `gpt-4-1106-preview`。 |
+| 配置项类型 | 示例 | 解释 |
+| --- | --- | --- |
+| 基本键值对 | `model=gpt-4` | 设置模型为 `gpt-4`。 |
+| 嵌套字段 | `tts.sttLocale=en-US` | 设置文本到语音服务的语言区域为 `en-US`。 |
+| 数组 | `plugins=search-engine,lobe-image-designer` | 启用 `search-engine` 和 `lobe-image-designer` 插件。 |
+| 中文逗号 | `plugins=search-engine，lobe-image-designer` | 同上，演示支持中文逗号分隔。 |
+| 多个配置项 | `model=glm-4;provider=zhipu` | 设置模型为 `glm-4` 且模型服务商为 `zhipu`。 |
+| 数字值 | `params.max_tokens=300` | 设置最大令牌数为 `300`。 |
+| 布尔值 | `enableAutoCreateTopic=true` | 启用自动创建主题。 |
+| 特殊字符 | `inputTemplate="Hello; I am a bot;"` | 设置输入模板为 `Hello; I am a bot;`。 |
+| 错误处理 | `model=gpt-4;maxToken` | 忽略无效条目 `maxToken`，仅解析出 `model=gpt-4`。 |
+| 值覆盖 | `model=gpt-4;model=gpt-4-1106-preview` | 如果键重复，使用最后一次出现的值，此处 `model` 的值为 `gpt-4-1106-preview`。 |
 
 相关阅读：
 
@@ -82,36 +57,44 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 
 ### 通用设置
 
+#### `ENABLE_OAUTH_SSO`
+
+- 类型：必选
+- 描述：为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。
+- 默认值: `-`
+- 示例: `1`
+
 #### `NEXTAUTH_SECRET`
 
-- 类型：必须
+- 类型：必选
 - 描述：用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32`.
 - 默认值: `-`
 - 示例: `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`
 
 ### Auth0
 
-> \[!NOTE] 注意事项：
->
-> 目前我们只支持 Auth0 身份验证服务提供商。如果您需要使用其他身份验证服务提供商，可以提交功能请求或 Pull Request。
+<Callout>
+  目前我们只支持 Auth0 身份验证服务提供商。如果您需要使用其他身份验证服务提供商，可以提交
+  [功能请求](https://github.com/lobehub/lobe-chat/issues/new/choose) 或 Pull Request。
+</Callout>
 
 #### `AUTH0_CLIENT_ID`
 
-- 类型：必须
+- 类型：必选
 - 描述: Auth0 应用程序的 Client ID，您可以访问[这里][auth0-client-page]并导航至应用程序设置来查看
 - 默认值: `-`
 - 示例: `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`
 
 #### `AUTH0_CLIENT_SECRET`
 
-- 类型：必须
+- 类型：必选
 - 描述: Auth0 应用程序的 Client Secret
 - 默认值: `-`
 - 示例: `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm`
 
 #### `AUTH0_ISSUER`
 
-- 类型：必须
+- 类型：必选
 - 描述: Auth0 应用程序的签发人 / 域
 - 默认值: `-`
 - 示例: `https://example.auth0.com`
@@ -134,12 +117,16 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 默认值：`https://api.openai.com/v1`
 - 示例：`https://api.chatanywhere.cn` 或 `https://aihubmix.com/v1`
 
-> \[!NOTE] 注意事项：
->
-> 请检查你的代理服务商的请求后缀，有的代理服务商会在请求后缀添加 `/v1`，有的则不会。
-> 如果你在测试时发现 AI 返回的消息为空，请尝试添加 `/v1` 后缀后重试。
+<Callout type={'warning'}>
+  请检查你的代理服务商的请求后缀，有的代理服务商会在请求后缀添加
+  `/v1`，有的则不会。如果你在测试时发现 AI 返回的消息为空，请尝试添加 `/v1` 后缀后重试。
+</Callout>
 
-是否填写 `/v1` 跟模型服务商有很大关系，比如 openai 的默认地址是 `api.openai.com/v1` 。如果你的代理上是转发了 `/v1` 这个接口，那么直接填 `proxy.com` 即可。 但如果模型服务商是直接转发了 `api.openai.com` 域名，那么你就要自己加上 `/v1` 这个 url。
+<Callout type={'info'}>
+  是否填写 `/v1` 跟模型服务商有很大关系，比如 openai 的默认地址是 `api.openai.com/v1`
+  。如果你的代理商转发了 `/v1` 这个接口，那么直接填 `proxy.com` 即可。
+  但如果模型服务商是直接转发了 `api.openai.com` 域名，那么你就要自己加上 `/v1` 这个 url。
+</Callout>
 
 相关讨论：
 
@@ -160,7 +147,7 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 
 ### Azure OpenAI
 
-如果你需要使用 Azure OpenAI 来提供模型服务，可以查阅 [使用 Azure OpenAI 部署](Deploy-with-Azure-OpenAI.zh-CN.md) 章节查看详细步骤，这里将列举和 Azure OpenAI 相关的环境变量。
+如果你需要使用 Azure OpenAI 来提供模型服务，可以查阅 [使用 Azure OpenAI 部署](../Deployment/Deploy-with-Azure-OpenAI.zh-CN.md) 章节查看详细步骤，这里将列举和 Azure OpenAI 相关的环境变量。
 
 #### `USE_AZURE_OPENAI`
 
@@ -271,12 +258,12 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 }
 ```
 
-## 角色服务
+## 助手市场
 
 ### `AGENTS_INDEX_URL`
 
 - 类型：可选
-- 描述：LobeChat 角色市场的索引地址，如果你自行部署了角色市场的服务，可以使用该变量来覆盖默认的插件市场地址
+- 描述：LobeChat 助手市场的索引地址，如果你自行部署了助手市场的服务，可以使用该变量来覆盖默认的市场地址
 - 默认值：`https://chat-agents.lobehub.com`
 
 ## 数据统计
@@ -332,8 +319,7 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 #### `NEXT_PUBLIC_ANALYTICS_UMAMI`
 
 - 类型：可选
-- 描述：用于开启 [Umami Analytics][umami-analytics-url] 的环境变量，设为 `1`
-  时开启 Umami Analytics
+- 描述：用于开启 [Umami Analytics][umami-analytics-url] 的环境变量，设为 `1` 时开启 Umami Analytics
 - 默认值： `-`
 - 示例：`1`
 

package/docs/self-hosting/upstream-sync.mdx

@@ -0,0 +1,66 @@
+import { Callout, Steps } from 'nextra/components';
+
+## `A` Vercel / Zeabur Deployment
+
+If you deployed your project according to the one-click deployment steps in the README, you may have noticed that you are always prompted with "updates available." This is because Vercel defaults to creating a new project for you instead of forking the original project, which prevents accurate update detection. We recommend following these steps to redeploy:
+
+- Delete the original repository;
+- Use the <kbd>Fork</kbd> button in the top right corner of the page to fork the original project;
+- Redeploy on `Vercel`.
+
+### Enable Automatic Updates
+
+<Callout>
+  If you encounter an error when executing `Upstream Sync`, please try executing it manually again
+</Callout>
+
+After forking the project, due to Github's limitations, you need to manually enable Workflows on the Actions page of your forked project and start the Upstream Sync Action. Once enabled, you can set up automatic updates to occur every hour.
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
+
+## `B` Docker Deployment
+
+Upgrading the Docker deployment version is very simple, you just need to redeploy the latest LobeChat image. Here are the commands required to perform these steps:
+
+<Steps>
+### Stop and Remove the Current Running LobeChat Container
+
+Assuming the LobeChat container is named `lobe-chat`, use the following commands to stop and remove the currently running LobeChat container:
+
+```fish
+docker stop lobe-chat
+docker rm lobe-chat
+```
+
+### Pull the Latest LobeChat Image
+
+Use the following command to pull the latest Docker image for LobeChat:
+
+```fish
+docker pull lobehub/lobe-chat
+```
+
+### Restart the Docker Container
+
+Redeploy the LobeChat container using the newly pulled image:
+
+```fish
+docker run -d -p 3210:3210 \
+  -e OPENAI_API_KEY=sk-xxxx \
+  -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \
+  -e ACCESS_CODE=lobe66 \
+  --name lobe-chat \
+  lobehub/lobe-chat
+```
+
+</Steps>
+
+Ensure that you have sufficient permissions to stop and remove the container before executing these commands, and that Docker has sufficient permissions to pull the new image.
+
+<Callout type={'info'}>
+
+**If I redeploy, will I lose my local chat records?**
+
+No need to worry, you won't. All of LobeChat's chat records are stored in your local browser. Therefore, when redeploying LobeChat using Docker, your chat records will not be lost.
+
+</Callout>

package/docs/{Deployment/Upstream-Sync.zh-CN.md → self-hosting/upstream-sync.zh-CN.mdx}

@@ -1,12 +1,6 @@
-# 自部署保持更新
+import { Callout, Steps } from 'nextra/components';
 
-## TOC
-
-- [`A` Vercel\`\` / Zeabur 部署](#a-vercel--zeabur-部署)
-  - [启动自动更新](#启动自动更新)
-- [`B` Docker 部署](#b-docker-部署)
-
-## `A` Vercel\`\` / Zeabur 部署
+## `A` Vercel / Zeabur 部署
 
 如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示 “有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照以下步骤重新部署：
 
@@ -16,33 +10,37 @@
 
 ### 启动自动更新
 
-> \[!NOTE]
->
-> 如果你在执行 `Upstream Sync` 时遇到错误，请手动执再行一次
+<Callout>如果你在执行 `Upstream Sync` 时遇到错误，请尝试手动执再行一次</Callout>
 
 当你 Fork 了项目后，由于 Github 的限制，你需要手动在你 Fork 的项目的 Actions 页面启用 Workflows，并启动 Upstream Sync Action。启用后，你可以设置每小时进行一次自动更新。
 
-![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
-![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
 
 ## `B` Docker 部署
 
 Docker 部署版本的升级非常简单，只需要重新部署 LobeChat 的最新镜像即可。 以下是执行这些步骤所需的指令：
 
-1. 停止并删除当前运行的 LobeChat 容器（假设 LobeChat 容器的名称是 `lobe-chat`）：
+<Steps>
+###  停止并删除当前运行的 LobeChat 容器
+
+假设 LobeChat 容器的名称是 `lobe-chat`，使用以下指令停止并删除当前运行的 LobeChat 容器：
 
 ```fish
 docker stop lobe-chat
 docker rm lobe-chat
 ```
 
-2. 拉取 LobeChat 的最新 Docker 镜像：
+### 拉取最新的 LobeChat 镜像
+
+使用以下命令拉取 LobeChat 的最新 Docker 镜像：
 
 ```fish
 docker pull lobehub/lobe-chat
 ```
 
-3. 使用新拉取的镜像重新部署 LobeChat 容器：
+### 重新启动 Docker 容器
+
+使用新拉取的镜像重新部署 LobeChat 容器：
 
 ```fish
 docker run -d -p 3210:3210 \
@@ -53,10 +51,14 @@ docker run -d -p 3210:3210 \
   lobehub/lobe-chat
 ```
 
+</Steps>
+
 确保在执行这些命令之前，您有足够的权限来停止和删除容器，并且 Docker 有足够的权限来拉取新的镜像。
 
-> \[!NOTE]
->
-> 重新部署的话，我本地的聊天记录会丢失吗？
->
-> 放心，LobeChat 的聊天记录全部都存储在你的本地浏览器中。因此使用 Docker 重新部署 LobeChat 时，你的聊天记录并不会丢失。
+<Callout type={'info'}>
+
+**重新部署的话，我本地的聊天记录会丢失吗？**
+
+放心，不会的。LobeChat 的聊天记录全部都存储在你的本地浏览器中。因此使用 Docker 重新部署 LobeChat 时，你的聊天记录并不会丢失。
+
+</Callout>