@lobehub/chat 1.0.0 → 1.0.2

package/docs/self-hosting/environment-variables/model-provider.zh-CN.mdx

@@ -0,0 +1,297 @@
+---
+title: LobeChat 模型服务商相关环境变量配置指南
+description: 了解如何配置各个模型服务商的环境变量以在 LobeChat 中使用不同的AI模型服务。
+tags:
+  - LobeChat
+  - 模型服务商
+  - 环境变量
+  - AI模型
+  - 配置指南
+---
+
+# 模型服务商
+
+LobeChat 在部署时提供了丰富的模型服务商相关的环境变量，你可以使用这些环境变量轻松定义需要在 LobeChat 中开启的模型服务商。
+
+## OpenAI
+
+### `ENABLED_OPENAI`
+
+- 类型：可选
+- 描述：默认启用 OpenAI 作为模型供应商，当设为 0 时关闭 OpenAI 服务
+- 默认值：`1`
+- 示例：`0`
+
+### `OPENAI_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 OpenAI 账户页面申请的 API 密钥，可以前往 [这里](https://platform.openai.com/api-keys) 查看
+- 默认值：-
+- 示例：`sk-xxxxxx...xxxxxx`
+
+### `OPENAI_PROXY_URL`
+
+- 类型：可选
+- 描述：如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL
+- 默认值：`https://api.openai.com/v1`
+- 示例：`https://api.chatanywhere.cn` 或 `https://aihubmix.com/v1`
+
+<Callout type={'warning'}>
+  请检查你的代理服务商的请求后缀，有的代理服务商会在请求后缀添加
+  `/v1`，有的则不会。如果你在测试时发现 AI 返回的消息为空，请尝试添加 `/v1` 后缀后重试。
+</Callout>
+
+<Callout type={'info'}>
+  是否填写 `/v1` 跟模型服务商有很大关系，比如 openai 的默认地址是 `api.openai.com/v1`
+  。如果你的代理商转发了 `/v1` 这个接口，那么直接填 `proxy.com` 即可。 但如果模型服务商是直接转发了
+  `api.openai.com` 域名，那么你就要自己加上 `/v1` 这个 url。
+</Callout>
+
+相关讨论：
+
+- [Docker 安装，配置好环境变量后，为何返回值是空白？](https://github.com/lobehub/lobe-chat/discussions/623)
+- [使用第三方接口报错的原因](https://github.com/lobehub/lobe-chat/discussions/734)
+- [代理服务器地址填了聊天没任何反应](https://github.com/lobehub/lobe-chat/discussions/1065)
+
+### `OPENAI_MODEL_LIST`
+
+- 类型：可选
+- 描述：用来控制模型列表，使用 `+` 增加一个模型，使用 `-` 来隐藏一个模型，使用 `模型名=展示名<扩展配置>` 来自定义模型的展示名，用英文逗号隔开。模型定义语法规则见 [模型列表][model-list]
+- 默认值：`-`
+- 示例：`+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-0125-preview=gpt-4-turbo`
+
+上面示例表示增加 `qwen-7b-chat` 和 `glm-6b` 到模型列表，而从列表中删除 `gpt-3.5-turbo`，并将 `gpt-4-0125-preview` 模型名字展示为 `gpt-4-turbo`。如果你想先禁用所有模型，再启用指定模型，可以使用 `-all,+gpt-3.5-turbo`，则表示仅启用 `gpt-3.5-turbo`。
+
+你可以在 [modelProviders](https://github.com/lobehub/lobe-chat/tree/main/src/config/modelProviders) 查找到当前的所有模型名。
+
+## Azure OpenAI
+
+如果你需要使用 Azure OpenAI 来提供模型服务，可以查阅 [使用 Azure OpenAI 部署](/docs/self-hosting/examples/azure-openai) 章节查看详细步骤，这里将列举和 Azure OpenAI 相关的环境变量。
+
+### `AZURE_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Azure OpenAI 账户页面申请的 API 密钥
+- 默认值：-
+- 示例：`c55168be3874490ef0565d9779ecd5a6`
+
+### `AZURE_ENDPOINT`
+
+- 类型：必选
+- 描述：Azure API 地址，从 Azure 门户检查资源时，可在 “密钥和终结点” 部分中找到此值
+- 默认值：`-`
+- 示例：`https://docs-test-001.openai.azure.com`
+
+### `AZURE_API_VERSION`
+
+- 类型：必选
+- 描述：Azure 的 API 版本，遵循 YYYY-MM-DD 格式
+- 默认值：`-`
+- 示例：`2024-02-01`，查阅 [最新版本](https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version)
+
+### `AZURE_MODEL_LIST`
+
+- 类型：必选
+- 描述：用来控制模型列表，使用 `模型名->部署名=展示名` 来自定义模型的展示名，用英文逗号隔开。支持扩展能力，其余语法规则详见 [模型列表][model-list]
+- 默认值：`-`
+- 示例：`gpt-35-turbo->my-deploy=GPT 3.5 Turbo` 或 `gpt-4-turbo->my-gpt4=GPT 4 Turbo<128000:vision:fc>`
+
+## Google AI
+
+### `GOOGLE_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Google AI Platform 申请的 API 密钥，用于访问 Google AI 服务
+- 默认值：-
+- 示例：`AIraDyDwcw254kwJaGjI9wwaHcdDCS__Vt3xQE`
+
+### `GOOGLE_PROXY_URL`
+
+- 类型：可选
+- 描述：如果你手动配置了 Google 接口代理，可以使用此配置项来覆盖默认的 Google API 请求基础 URL
+- 默认值：`https://generativelanguage.googleapis.com`
+- 示例：`https://api.genai.gd.edu.kg/google`
+
+## Anthropic AI
+
+### `ANTHROPIC_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Anthropic AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`sk-ant-apixx-xxxxxxxxx-xxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxx`
+
+### `ANTHROPIC_PROXY_URL`
+
+- 类型：可选
+- 描述：如果你手动配置了 Anthropic 接口代理，可以使用此配置项来覆盖默认的 Anthropic API 请求基础 URL
+- 默认值：`https://api.anthropic.com`
+- 示例：`https://my-anthropic-proxy.com`
+
+## AWS Bedrock
+
+### `ENABLED_AWS_BEDROCK`
+
+- 类型：可选
+- 描述：当设为 1 时启用 AWS Bedrock 服务
+- 默认值：`0`
+- 示例：`1`
+
+### `AWS_ACCESS_KEY_ID`
+
+- 类型：必选
+- 描述：用于 AWS 服务认证的访问键 ID
+- 默认值：-
+- 示例：`AKIA5STVRLFSB4S9HWBR`
+
+### `AWS_SECRET_ACCESS_KEY`
+
+- 类型：必选
+- 描述：用于 AWS 服务认证的密钥
+- 默认值：-
+- 示例：`Th3vXxLYpuKcv2BARktPSTPxx+jbSiFT6/0w7oEC`
+
+### `AWS_REGION`
+
+- 类型：可选
+- 描述：AWS 服务的区域设置
+- 默认值：`us-east-1`
+- 示例：`us-east-1`
+
+## DeepSeek AI
+
+### `DEEPSEEK_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 DeepSeek AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`sk-xxxxxx...xxxxxx`
+
+## OpenRouter AI
+
+### `OPENROUTER_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 OpenRouter AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`sk-or-v1-xxxxxx...xxxxxx=`
+
+### `OPENROUTER_MODEL_LIST`
+
+- 类型：可选
+- 描述：用于指定自定义 OpenRouter 模型列表。模型定义语法规则见 [模型列表][model-list]
+- 默认值：`-`
+- 示例：`-all,+01-ai/yi-34b-chat,+huggingfaceh4/zephyr-7b-beta`
+
+## TogetherAI
+
+### `TOGETHERAI_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 TogetherAI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`xxxxxx...xxxxxx`
+
+### `TOGETHERAI_MODEL_LIST`
+
+- 类型：可选
+- 描述：用于指定自定义 Together AI 的模型列表。模型定义语法规则见 [模型列表][model-list]
+- 默认值：`-`
+- 示例：`01-ai/yi-34b-chat`
+
+## Ollama
+
+### `ENABLED_OLLAMA`
+
+- 类型：可选
+- 描述：默认启用 Ollama 作为模型供应商，当设为 0 时关闭 Ollama 服务
+- 默认值：`1`
+- 示例：`0`
+
+### `OLLAMA_PROXY_URL`
+
+- 类型：必选
+- 描述：用于启用 Ollama 服务，设置后可在语言模型列表内展示可选开源语言模型，也可以指定自定义语言模型
+- 默认值：-
+- 示例：`http://127.0.0.1:11434`
+
+### `OLLAMA_MODEL_LIST`
+
+- 类型：可选
+- 描述：用于指定自定义 Ollama 语言模型。模型定义语法规则见 [模型列表][model-list]
+- 默认值：-
+- 示例：`qwen:32B`
+
+## Moonshot AI
+
+### `MOONSHOT_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Moonshot AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`Y2xpdGhpMzNhZXNoYjVtdnZjMWc6bXNrLWIxQlk3aDNPaXpBWnc0V1RaMDhSRmRFVlpZUWY=`
+
+## Perplexity AI
+
+### `PERPLEXITY_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Perplexity AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`pplx-xxxxxx...xxxxxx`
+
+## Minimax AI
+
+### `MINIMAX_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Minimax AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`xxxxxx...xxxxxx`
+
+## Mistral AI
+
+### `MISTRAL_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Mistral AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`xxxxxx...xxxxxx=`
+
+## Groq AI
+
+### `GROQ_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 Groq AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`gsk_xxxxxx...xxxxxx`
+
+## 智谱 AI
+
+### `ZHIPU_API_KEY`
+
+- 类型：必选
+- 描述：这是你在 智谱 AI 服务中申请的 API 密钥
+- 默认值：-
+- 示例：`4582d332441a313f5c2ed9824d1798ca.rC8EcTAhgbOuAuVT`
+
+## 01 AI
+
+### `ZEROONE_API_KEY`
+
+- 类型：必选
+- 描述：这是你在零一万物服务中申请的 API 密钥
+- 默认值：-
+- 示例：`xxxxxx...xxxxxx`
+
+[model-list]: /docs/self-hosting/advanced/model-list
+
+## 通义千问
+
+### `QWEN_API_KEY`
+
+- 类型：必选
+- 描述：这是你在阿里云百炼平台上获取的 DashScope API 密钥
+- 默认值：-
+- 示例：`sk-xxxxx...xxxxx`

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

@@ -0,0 +1,22 @@
+---
+title: LobeChat Environment Variables - Customizing Guide
+description: >-
+  Learn how to customize LobeChat configuration using environment variables for
+  additional features and options.
+tags:
+  - LobeChat
+  - Environment Variables
+  - Configuration
+  - Customization
+---
+
+# Environment Variables
+
+LobeChat provides some additional configuration options when deployed, which can be customized using environment variables.
+
+<Cards>
+  <Card href={'environment-variables/basic'} title={'Basic Environment Variables'} />
+  <Card href={'environment-variables/model-provider'} title={'Model Service Providers'} />
+  <Cards href={'environment-variables/auth'} title={'Authentication'} />
+  <Cards href={'environment-variables/analytics'} title={'Data Analytics'} />
+</Cards>

package/docs/self-hosting/environment-variables.zh-CN.mdx

@@ -0,0 +1,20 @@
+---
+title: LobeChat 环境变量 - 自定义设置
+description: 了解如何使用环境变量在部署 LobeChat 时进行自定义设置。包括基础环境变量和模型服务商设置。
+tags:
+  - LobeChat
+  - 环境变量
+  - 自定义设置
+  - 模型服务商
+---
+
+# 环境变量
+
+LobeChat 在部署时提供了一些额外的配置项，你可以使用环境变量进行自定义设置。
+
+<Cards>
+  <Cards href={'environment-variables/basic'} title={'基础环境变量'} />
+  <Cards href={'environment-variables/model-provider'} title={'模型服务商'} />
+  <Cards href={'environment-variables/auth'} title={'身份验证'} />
+  <Cards href={'environment-variables/analytics'} title={'数据统计'} />
+</Cards>

package/docs/self-hosting/examples/azure-openai.mdx

@@ -0,0 +1,46 @@
+---
+title: Configuring Azure OpenAI for LobeChat
+description: >-
+  Learn how to configure Azure OpenAI for LobeChat, including interface
+  configuration, and deployment settings.
+tags:
+  - Azure OpenAI
+  - LobeChat
+  - Configuration
+  - Azure API
+  - Model Service Provider
+---
+
+# Integrating with Azure OpenAI
+
+LobeChat supports using [Azure OpenAI](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/concepts/models) as the model service provider for OpenAI. This article will explain how to configure Azure OpenAI.
+
+## Configuring in the Interface
+
+Click in the bottom left corner "Actions" - "Settings", then switch to the "Language Model" tab and enable the "Azure OpenAI" switch to start using Azure OpenAI.
+
+<Image
+  alt="Configuring in the Interface"
+  src="https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267083420-422a3714-627e-4bef-9fbc-141a2a8ca916.png"
+/>
+
+You can fill in the corresponding configuration items as needed:
+
+- **API Key**: The API key you applied for on the Azure OpenAI account page, which can be found in the "Keys and Endpoints" section.
+- **API Address**: Azure API address, which can be found in the "Keys and Endpoints" section when checking resources in the Azure portal.
+- **Azure API Version**: The API version of Azure, following the format YYYY-MM-DD. Refer to the [latest version](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions).
+- ** Model List**: set your model list
+
+After completing the configuration of the above fields, click "Check". If it prompts "Check passed", it means the configuration was successful.
+
+## Configuration during Deployment
+
+If you want the deployed version to be pre-configured with Azure OpenAI for end users to use directly, you need to configure the following environment variables during deployment:
+
+| Environment Variable | Type | Description | Default Value | Example |
+| --- | --- | --- | --- | --- |
+| `AZURE_API_KEY` | Required | This is the API key you obtained from the Azure OpenAI account page | - | `c55168be3874490ef0565d9779ecd5a6` |
+| `AZURE_ENDPOINT` | Required | Azure API address, can be found in the "Keys and Endpoints" section when checking resources in the Azure portal | - | `https://docs-test-001.openai.azure.com` |
+| `AZURE_API_VERSION` | Required | Azure API version, following the format YYYY-MM-DD | 2023-08-01-preview | `-`, see [latest version](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions) |
+| `AZURE_MODEL_LIST` | Required | Used to control the model list, use `+` to add a model, use `-` to hide a model, use `id->deplymentName=displayName` to customize the display name of a model, separated by commas. Definition syntax rules see [Model List](/docs/self-hosting/advanced/model-list) | - | `gpt-35-turbo->my-deploy=GPT 3.5 Turbo` or `gpt-4-turbo->my-gpt4=GPT 4 Turbo<128000:vision:fc>` |
+| `ACCESS_CODE` | Optional | Add a password to access LobeChat. You can set a long password to prevent brute force attacks. When this value is separated by commas, it becomes an array of passwords | - | `awCT74` or `e3@09!` or `code1,code2,code3` |

package/docs/self-hosting/examples/azure-openai.zh-CN.mdx

@@ -0,0 +1,48 @@
+---
+title: 在 LobeChat 中集成 Azure OpenAI
+description: 了解如何在 LobeChat 中配置 Azure OpenAI。一步步指导从界面配置到部署时的环境变量设置。
+tags:
+  - Azure OpenAI
+  - 配置指南
+  - 使用限制
+  - 语言模型
+  - Azure API
+  - API密钥
+  - 环境变量
+---
+
+# 与 Azure OpenAI 集成使用
+
+LobeChat 支持使用 [Azure OpenAI](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/concepts/models) 作为 OpenAI 的模型服务商，本文将介绍如何配置 Azure OpenAI。
+
+## 在界面中配置
+
+点击左下角「操作」 -「设置」，切到 「语言模型」 Tab 后通过开启「Azure OpenAI」开关，即可开启使用 Azure OpenAI。
+
+<Image
+  alt="在界面中配置"
+  src="https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267083420-422a3714-627e-4bef-9fbc-141a2a8ca916.png"
+/>
+
+你按需填写相应的配置项：
+
+- **APIKey**：你在 Azure OpenAI 账户页面申请的 API 密钥，可在 “密钥和终结点” 部分中找到此值
+- **API 地址**：Azure API 地址，从 Azure 门户检查资源时，可在 “密钥和终结点” 部分中找到此值
+- **Azure Api Version**： Azure 的 API 版本，遵循 YYYY-MM-DD 格式，查阅[最新版本](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions)
+- **模型列表**： 用来控制模型列表，你可以自行配置你的部署模型。
+
+完成上述字段配置后，点击「检查」，如果提示「检查通过」，则说明配置成功。
+
+<br />
+
+## 在部署时配置
+
+如果你希望部署的版本直接配置好 Azure OpenAI，让终端用户直接使用，那么你需要在部署时配置以下环境变量：
+
+| 环境变量 | 类型 | 描述 | 默认值 | 示例 |
+| --- | --- | --- | --- | --- |
+| `AZURE_API_KEY` | 必选 | 这是你在 Azure OpenAI 账户页面申请的 API 密钥 | - | `c55168be3874490ef0565d9779ecd5a6` |
+| `AZURE_ENDPOINT` | 必选 | Azure API 地址，从 Azure 门户检查资源时，可在 “密钥和终结点” 部分中找到此值 | - | `https://docs-test-001.openai.azure.com` |
+| `AZURE_API_VERSION` | 必选 | Azure 的 API 版本，遵循 YYYY-MM-DD 格式 | 2023-08-01-preview | `-`，查阅[最新版本](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions) |
+| `AZURE_MODEL_LIST` | 必选 | 用来控制模型列表，使用 `模型名->部署名=展示名` 来自定义模型的展示名，用英文逗号隔开。支持扩展能力，其余语法规则详见 [模型列表][model-list] | - | `gpt-35-turbo->my-deploy=GPT 3.5 Turbo` 或 `gpt-4-turbo->my-gpt4=GPT 4 Turbo<128000:vision:fc>` |
+| `ACCESS_CODE` | 可选 | 添加访问 LobeChat 的密码，你可以设置一个长密码以防被爆破，该值用逗号分隔时为密码数组 | - | `awCT74` 或 `e3@09!` or `code1,code2,code3` |

package/docs/self-hosting/examples/ollama.mdx

@@ -0,0 +1,104 @@
+---
+title: Integrating LobeChat with Ollama for Enhanced Language Models
+description: >-
+  Learn how to configure and deploy LobeChat to leverage Ollama's powerful
+  language models locally. Follow the guide to run Ollama and LobeChat on your
+  system.
+tags:
+  - Ollama integration
+  - LobeChat configuration
+  - Local deployment
+  - Language models
+  - Ollama usage
+---
+
+# Integrating with Ollama
+
+Ollama is a powerful framework for running large language models (LLMs) locally, supporting various language models including Llama 2, Mistral, and more. Now, LobeChat supports integration with Ollama, meaning you can easily use the language models provided by Ollama to enhance your application within LobeChat.
+
+This document will guide you on how to configure and deploy LobeChat to use Ollama:
+
+## Running Ollama Locally
+
+First, you need to install Ollama. For detailed steps on installing and configuring Ollama, please refer to the [Ollama Website](https://ollama.com).
+
+## Running LobeChat Locally
+
+Assuming you have already started the Ollama service locally on port `11434`. Run the following Docker command to start LobeChat locally:
+
+```bash
+docker run -d -p 3210:3210 -e OLLAMA_PROXY_URL=http://host.docker.internal:11434/v1 lobehub/lobe-chat
+```
+
+Now, you can use LobeChat to converse with the local LLM.
+
+For more information on using Ollama in LobeChat, please refer to [Ollama Usage](/docs/usage/providers/ollama).
+
+## Accessing Ollama from Non-Local Locations
+
+When you first initiate Ollama, it is configured to allow access only from the local machine. To enable access from other domains and set up port listening, you will need to adjust the environment variables `OLLAMA_ORIGINS` and `OLLAMA_HOST` accordingly.
+
+### Ollama Environment Variables
+
+| Environment Variable | Description                         | Default Value                                      | Additional Information                               |
+| -------------------- | ----------------------------------- | --------------------------------------------------- | ---------------------------------------------------- |
+| `OLLAMA_HOST`       | Specifies the host and port for binding | "127.0.0.1:11434"                                 | Use "0.0.0.0:port" to make the service accessible from any machine |
+| `OLLAMA_ORIGINS`    | Comma-separated list of permitted cross-origin sources | Restricted to local access                       | Set to "*" to avoid CORS, please set on demand          |
+| `OLLAMA_MODELS`     | Path to the directory where models are located | "~/.ollama/models" or "/usr/share/ollama/.ollama/models" | Can be customized based on requirements              |
+| `OLLAMA_KEEP_ALIVE` | Duration that the model stays loaded in GPU memory | "5m"                                              | Dynamically loading and unloading models can reduce GPU load but may increase disk I/O |
+| `OLLAMA_DEBUG`      | Enable additional debugging logs by setting to 1 | Typically disabled                                 |                                                        |
+
+### Setting environment variables on Windows
+
+On Windows, Ollama inherits your user and system environment variables.
+
+1. First Quit Ollama by clicking on its tray icon and selecting Quit
+2. Edit system environment variables from the control panel
+3. Edit or create New variable(s) for your user account for `OLLAMA_HOST`, `OLLAMA_ORIGINS`, etc.
+4. Click OK/Apply to save
+5. Restart it
+
+### Setting environment variables on Mac
+
+If Ollama is run as a macOS application, environment variables should be set using `launchctl`:
+
+1. For each environment variable, call `launchctl setenv`.
+
+    ```bash
+    launchctl setenv OLLAMA_HOST "0.0.0.0"
+    launchctl setenv OLLAMA_ORIGINS "*"
+    ```
+
+2. Restart Ollama application.
+
+### Setting environment variables on Linux
+
+If Ollama is run as a systemd service, environment variables should be set using `systemctl`:
+
+1. Edit the systemd service by calling `sudo systemctl edit ollama.service`.
+
+    ```bash
+    sudo systemctl edit ollama.service
+    ```
+
+2. For each environment variable, add a line `Environment` under section `[Service]`:
+
+    ```bash
+    [Service]
+    Environment="OLLAMA_HOST=0.0.0.0"
+    Environment="OLLAMA_ORIGINS=*"
+    ```
+
+3. Save and exit.
+4. Reload `systemd` and restart Ollama:
+
+    ```bash
+    sudo systemctl daemon-reload
+    sudo systemctl restart ollama
+    ```
+
+### Setting environment variables on Docker
+
+If Ollama is run as a Docker container, you can add the environment variables to the `docker run` command.
+
+For further guidance on configuration, consult the [Ollama Official Documentation](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server).

package/docs/self-hosting/examples/ollama.zh-CN.mdx

@@ -0,0 +1,103 @@
+---
+title: 在 LobeChat 中集成 Ollama
+description: 学习如何在 LobeChat 中配置与部署 Ollama 语言模型框架，提升本地大模型使用体验。
+tags:
+  - Ollama
+  - LobeChat
+  - 语言模型
+  - 集成
+  - 配置
+  - 部署
+---
+
+# 与 Ollama 集成
+
+Ollama 是一款强大的本地运行大型语言模型（LLM）的框架，支持多种语言模型，包括 Llama 2, Mistral 等。现在，LobeChat 已经支持与 Ollama 的集成，这意味着你可以在 LobeChat 中轻松使用 Ollama 提供的语言模型来增强你的应用。
+
+本文档将指导你如何配置与部署 LobeChat 来使用 Ollama：
+
+## 本地启动 Ollama
+
+首先，你需要安装 Ollama，安装与配置 Ollama 的详细步骤可以参考 [Ollama 官方站点](https://ollama.com)。
+
+## 本地运行 LobeChat
+
+假设你已经在本地 `11434` 端口启动了 Ollama 服务。运行以下 Docker 命令行，在本地启动 LobeChat：
+
+```bash
+docker run -d -p 3210:3210 -e OLLAMA_PROXY_URL=http://host.docker.internal:11434/v1 lobehub/lobe-chat
+```
+
+接下来，你就可以使用 LobeChat 与本地 LLM 对话了。
+
+关于在 LobeChat 中使用 Ollama 的更多信息，请查阅 [Ollama 使用](/docs/usage/providers/ollama)。
+
+## 非本地访问 Ollama
+
+由于 Ollama 默认参数在启动时设置了仅本地访问，所以跨域访问以及端口监听需要进行额外的环境变量设置 `OLLAMA_ORIGINS` 和 `OLLAMA_HOST`。
+
+### Ollama 环境变量
+
+| 环境变量 | 描述                           | 默认值                                                   | 附加说明                                                 |
+| ---------- | -------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `OLLAMA_HOST`         | 绑定的主机和端口               | "127.0.0.1:11434"                                        | 设置 0.0.0.0:端口号 可以指定所有人访问特定端口           |
+| `OLLAMA_ORIGINS`         | 允许的跨域源列表，逗号分隔     | 仅本地访问                                               |  设置 "*" 可以避免 CORS 跨域错误，按需设置              |
+| `OLLAMA_MODELS`         | 模型存放的路径                 | "~/.ollama/models" 或 "/usr/share/ollama/.ollama/models" | 按需指定                                                 |
+| `OLLAMA_KEEP_ALIVE`         | 模型在显存中保持加载的持续时间 | "5m"                                                     | 按需加载和释放显存可以有效降低显卡压力，但会增加硬盘读写 |
+| `OLLAMA_DEBUG`         | 设置为 1 以启用额外的调试日志  | 默认关闭                                                 |                                                          |
+
+### 在 Windows 上设置环境变量
+
+在 Windows 上，Ollama 继承了您的用户和系统环境变量。
+
+1. 首先通过 Windows 任务栏点击 Ollama 退出程序。
+2. 从控制面板编辑系统环境变量。
+3. 为您的用户账户编辑或新建 Ollama 的环境变量，比如`OLLAMA_HOST`、`OLLAMA_ORIGINS`等。
+4. 点击`OK/应用`保存。
+5. 重新运行`Ollama`。
+
+### 在 Mac 上设置环境变量
+
+如果 Ollama 作为 macOS 应用程序运行，你需要使用 `launchctl` 设置环境变量：
+
+1. 对于每个环境变量，调用 `launchctl setenv`。
+
+    ```bash
+    launchctl setenv OLLAMA_HOST "0.0.0.0"
+    launchctl setenv OLLAMA_ORIGINS "*"
+    ```
+
+2. 重启 Ollama 应用程序。
+
+### 在 Linux 上设置环境变量
+
+如果 Ollama 作为 systemd 服务运行，应该使用`systemctl`设置环境变量：
+
+1. 通过调用`sudo systemctl edit ollama.service`编辑 systemd 服务。
+
+    ```bash
+    sudo systemctl edit ollama.service
+    ```
+
+2. 对于每个环境变量，在`[Service]`部分下添加`Environment`：
+
+    ```bash
+    [Service]
+    Environment="OLLAMA_HOST=0.0.0.0"
+    Environment="OLLAMA_ORIGINS=*"
+    ```
+
+3. 保存并退出。
+4. 重载`systemd`并重启 Ollama：
+
+    ```bash
+    sudo systemctl daemon-reload
+    sudo systemctl restart ollama
+    ```
+
+### 在 Docker 上设置环境变量
+
+如果 Ollama 作为 Docker 容器运行，你可以将环境变量添加到 `docker run` 命令中。
+
+详细配置方法可以参考 [Ollama 官方文档](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server)。
+

package/docs/self-hosting/faq/no-v1-suffix.mdx

@@ -0,0 +1,30 @@
+---
+title: >-
+  Troubleshooting `OPENAI_PROXY_URL` in LobeChat Configuration for Empty
+  Response
+description: >-
+  Learn how to troubleshoot and resolve the issue of receiving an empty response
+  after configuring the LobeChat `OPENAI_PROXY_URL` environment variable.
+tags:
+  - OPENAI_PROXY_URL
+  - environment variable
+  - configuration troubleshooting
+---
+
+# Configuring `OPENAI_PROXY_URL` Environment Variable but Getting Empty Response
+
+### Problem Description
+
+After configuring the `OPENAI_PROXY_URL` environment variable, you may encounter a situation where the AI returns an empty message. This may be due to an incorrect configuration of `OPENAI_PROXY_URL`.
+
+### Solution
+
+Recheck and confirm whether `OPENAI_PROXY_URL` is set correctly, including whether the `/v1` suffix is added correctly (if required).
+
+### Related Discussion Links
+
+- [Why is the return value blank after configuring environment variables in Docker?](https://github.com/lobehub/lobe-chat/discussions/623)
+- [Reasons for errors when using third-party interfaces](https://github.com/lobehub/lobe-chat/discussions/734)
+- [No response when the proxy server address is filled in for chat](https://github.com/lobehub/lobe-chat/discussions/1065)
+
+If the problem still cannot be resolved, it is recommended to raise the issue in the community, providing relevant logs and configuration information for other developers or maintainers to offer assistance.