references/lobe-chat
1
0
Fork 0
mirror of https://github.com/lobehub/lobe-chat.git synced 2026-06-13 19:20:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 docs: Update README

Browse Source
This commit is contained in:
canisminor1990
2023-09-12 18:01:33 +08:00
parent c65094cd92
commit 7c1df27241
8 changed files with 196 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+42 -4
View File
@@ -10,7 +10,7 @@
LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-performance chatbot framework. <br/> It supports one-click free deployment of your private ChatGPT/LLM web application.
**English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
**English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Wiki][wiki-url] · [Report Bug][issues-url] · [Request Feature][issues-url]
<!-- SHIELD GROUP -->
@@ -26,7 +26,7 @@ LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-perform
[![Deploy with Vercel][deploy-button-image]][deploy-url]
![](https://gw.alipayobjects.com/zos/kitchen/3uH7fYVvfO/lobechat.webp)
![](https://gw.alipayobjects.com/zos/kitchen/RKnWrrfuMl/welcome.webp)
</div>
@@ -39,6 +39,8 @@ LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-perform
- [✨ Features](#-features)
- [📸 Snapshot](#-snapshot)
- [🛳 Self Hosting](#-self-hosting)
- [Keep Updated](#keep-updated)
@@ -90,6 +92,42 @@ Please be aware that LobeChat is currently under active development，feedback i
</div>
## 📸 Snapshot
![](https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp)
**Progress Web App**
Utilize the Progressive Web Application ([PWA](https://support.google.com/chrome/answer/9658361)) technology to achieve a seamless LobeChat experience on your computer or mobile device.
> **Note**\
> If you are unfamiliar with the installation process of PWA, you can add LobeChat as your desktop application (also applicable to mobile devices) by following these steps:
>
> - Launch the Chrome or Edge browser on your computer
> - Visit the LobeChat webpage
> - In the upper right corner of the address bar, click on the <kbd>Install</kbd> icon
> - Follow the instructions on the screen to complete the PWA installation
![](https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp)
**Theme Mode Selection**
LobeChat provides two theme modes, light and dark, along with color customization options. By default, the theme follows the system settings, but you can also manually switch in the settings.
![](https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp)
**Mobile Device Adaptation**
We have designed a series of adaptations for mobile devices to enhance user experience. We are currently iterating the version for mobile experience, and we welcome any suggestions or ideas you might have.
> 🚧 Additional snapshots and demonstrations are being progressively added...
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🛳 Self Hosting
LobeChat provides a [self-hosted version][deploy-url] with Vercel. This allows you to build your own chatbot within a few minutes, without any prior knowledge. If you want to deploy this service yourself, you can follow these steps:
@@ -212,8 +250,7 @@ Contributions of all types are more than welcome, if you are interested in contr
---
<details>
<summary><h4>📝 License</h4></summary>
<details><summary><h4>📝 License</h4></summary>
[![][fossa-license-shield]][fossa-license-url]
@@ -277,3 +314,4 @@ This project is [MIT](./LICENSE) licensed.
[submit-agents-url]: https://github.com/lobehub/lobe-chat-agents
[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins
[wiki-url]: https://github.com/lobehub/lobe-chat/wiki
README.zh-CN.md
+46 -4
View File
@@ -10,7 +10,7 @@
LobeChat 是一个开源的、可扩展的（[Function Calling][fc-url]）高性能聊天机器人框架。<br/> 它支持一键免费部署私人 ChatGPT/LLM 网页应用程序。
[English](./README.md) · **简体中文** · [更新日志](./CHANGELOG.md) · [报告问题][issues-url] · [请求功能][issues-url]
[English](./README.md) · **简体中文** · [更新日志](./CHANGELOG.md) · [文档][wiki-url] · [报告问题][issues-url] · [请求功能][issues-url]
<!-- SHIELD GROUP -->
@@ -26,7 +26,7 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-url]）高性
[![Deploy with Vercel][deploy-button-image]][deploy-url]
![](https://gw.alipayobjects.com/zos/kitchen/3uH7fYVvfO/lobechat.webp)
![](https://gw.alipayobjects.com/zos/kitchen/RKnWrrfuMl/welcome.webp)
</div>
@@ -39,6 +39,8 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-url]）高性
- [✨ 功能特性](#-功能特性)
- [📸 快照预览](#-快照预览)
- [🛳 开箱即用](#-开箱即用)
- [保持更新](#保持更新)
@@ -90,6 +92,46 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-url]）高性
</div>
## 📸 快照预览
![](https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp)
**PWA 渐进式 Web 应用**
利用渐进式 Web 应用 [PWA](https://support.google.com/chrome/answer/9658361) 技术，您可在电脑或移动设备上实现流畅的 LobeChat 体验。
> **Note**\
> 若您未熟悉 PWA 的安装过程，您可以按照以下步骤将 LobeChat 添加为您的桌面应用（也适用于移动设备）：
>
> - 在电脑上运行 Chrome 或 Edge 浏览器
> - 访问 LobeChat 网页
> - 在地址栏的右上角，单击 <kbd>安装</kbd> 图标
> - 根据屏幕上的指示完成 PWA 的安装
<br/>
![](https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp)
**主题模式选择**
LobeChat 提供了亮色和暗色两种主题模式以及颜色定制选项，默认情况下，主题会跟随系统设置，您也可以在设置中手动切换。
<br/>
![](https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp)
**移动设备适配**
我们针对移动设备进行了一系列适配设计以提升用户体验。目前我们正在对移动端的体验进行版本迭代，如果您有任何建议或想法，我们非常欢迎您提供反馈。
> 🚧 更多快照和演示正在陆续添加中...
<div align="right">
[![][back-to-top]](#readme-top)
</div>
## 🛳 开箱即用
LobeChat 提供了 Vercel 的 [自托管版本][deploy-url]。这使你可以在几分钟内构建自己的聊天机器人，无需任何基础知识。如果想自己部署该服务，可以按照以下步骤进行操作：
@@ -212,8 +254,7 @@ $ pnpm dev
---
<details>
<summary><h4>📝 License</h4></summary>
<details><summary><h4>📝 License</h4></summary>
[![][fossa-license-shield]][fossa-license-url]
@@ -277,3 +318,4 @@ This project is [MIT](./LICENSE) licensed.
[submit-agents-url]: https://github.com/lobehub/lobe-chat-agents
[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins
[wiki-url]: https://github.com/lobehub/lobe-chat/wiki
docs/Deploy-with-Azure-OpenAI.md
+2
View File
@@ -31,6 +31,8 @@ You can fill in the corresponding configuration items as needed:
After completing the above field configuration, click on "Check". If the prompt says "Check Passed", it means the configuration was successful.
<br/>
## Configuration at Deployment
If you want the deployed version to be directly configured with Azure OpenAI for end users to use immediately, you need to configure the following environment variables at deployment:
docs/Deploy-with-Azure-OpenAI.zh-CN.md
+2
View File
@@ -31,6 +31,8 @@ LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型
完成上述字段配置后，点击「检查」，如果提示「检查通过」，则说明配置成功。
<br/>
## 在部署时配置
如果你希望部署的版本直接配置好 Azure OpenAI，让终端用户直接使用，那么你需要在部署时配置以下环境变量：
docs/Home.md
+4 -2
View File
@@ -29,11 +29,11 @@ LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-perform
- [Plugin Index and Submit][plugin-index] | [插件索引与提交][plugin-index-cn]
- [Plugin Development](Plugin-Development) | [插件开发](Plugin-Development.zh-CN)
- [Plugin SDK Docs][plugin-sdk] | [插件 SDK 文档][plugin-skd-cn]
---
<details>
<summary><h4>📝 License</h4></summary>
<details><summary><h4>📝 License</h4></summary>
[![][fossa-license-shield]][fossa-license-url]
@@ -52,4 +52,6 @@ This project is [MIT][license-url] licensed.
[license-url]: https://github.com/lobehub/lobe-chat/blob/main/LICENSE
[plugin-index]: https://github.com/lobehub/lobe-chat-plugins
[plugin-index-cn]: https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md
[plugin-sdk]: https://chat-plugin-sdk.lobehub.com
[plugin-skd-cn]: https://chat-plugin-sdk.lobehub.com
[profile-url]: https://github.com/lobehub
docs/Plugin-Development.md
+44 -12
View File
@@ -6,9 +6,9 @@
- [Custom Plugin Workflow](#custom-plugin-workflow)
- [1. Create and Start a Plugin Project](#1-create-and-start-a-plugin-project)
- [2. Add the Local Plugin in LobeChat Role Settings](#2-add-the-local-plugin-in-lobechat-role-settings)
- [3. Test the Plugin Functionality in a Session](#3-test-the-plugin-functionality-in-a-session)
- [**`1`** Create and Start a Plugin Project](#1-create-and-start-a-plugin-project)
- [**`2`** Add the Local Plugin in LobeChat Role Settings](#2-add-the-local-plugin-in-lobechat-role-settings)
- [**`3`** Test the Plugin Functionality in a Session](#3-test-the-plugin-functionality-in-a-session)
- [Local Plugin Development](#local-plugin-development)
@@ -19,6 +19,10 @@
- [Plugin Deployment and Publication](#plugin-deployment-and-publication)
- [Plugin Shield](#plugin-shield)
- [Link](#link)
## Plugin Composition
A LobeChat plugin consists of the following components:
@@ -30,11 +34,13 @@ A LobeChat plugin consists of the following components:
- **Server-side**: Implement the API capabilities described in the manifest.
- **Frontend UI** (optional): Implement the interface described in the manifest, which will be displayed in plugin messages to provide richer information display than plain text.
<br/>
## Custom Plugin Workflow
To integrate a plugin into LobeChat, you need to add and use a custom plugin in LobeChat. This section will guide you through the process.
### 1. Create and Start a Plugin Project
### **`1`** Create and Start a Plugin Project
First, you need to create a plugin project locally. You can use the [lobe-chat-plugin-template][lobe-chat-plugin-template-url] template we have prepared:
@@ -49,31 +55,31 @@ When you see `ready started server on 0.0.0.0:3400, url: http://localhost:3400`,
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259526-9ef25272-4312-429b-93bc-a95515727ed3.png)
### 2. Add the Local Plugin in LobeChat Role Settings
### **`2`** Add the Local Plugin in LobeChat Role Settings
Next, go to LobeChat, create a new assistant, and go to its session settings page:
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259643-1a9cc34a-76f3-4ccf-928b-129654670efd.png)
Click the "Add" button on the right side of "Plugin List" to open the custom plugin add dialog:
Click the <kbd>Add</kbd> button on the right side of "Plugin List" to open the custom plugin add dialog:
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259748-2ef6a244-39bb-483c-b359-f156ffcbe1a4.png)
Enter `http://localhost:3400/manifest-dev.json` in the "Plugin Manifest URL" field, which is the URL of the locally started plugin manifest.
Enter `http://localhost:3400/manifest-dev.json` in the `Plugin Manifest URL` field, which is the URL of the locally started plugin manifest.
At this point, you should see that the identifier of the plugin has been automatically recognized as `chat-plugin-template`. Then fill in the remaining form fields (only the title is required) and click the "Save" button to complete the custom plugin addition.
At this point, you should see that the identifier of the plugin has been automatically recognized as `chat-plugin-template`. Then fill in the remaining form fields (only the title is required) and click the <kbd>Save</kbd> button to complete the custom plugin addition.
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259964-59f4906d-ae2e-4ec0-8b43-db36871d0869.png)
After adding the plugin, you can see the newly added plugin in the plugin list. If you need to modify the plugin's configuration, you can click the "Settings" button to make changes.
After adding the plugin, you can see the newly added plugin in the plugin list. If you need to modify the plugin's configuration, you can click the <kbd>Settings</kbd> button to make changes.
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260093-a0363c74-0b5b-48dd-b103-2db6b4a8262e.png)
### 3. Test the Plugin Functionality in a Session
### **`3`** Test the Plugin Functionality in a Session
Next, we need to test the functionality of the custom plugin.
Click the "Back" button to go back to the session area, and then send a message to the assistant: "What should I wear?" The assistant will try to ask you about your gender and current mood.
Click the <kbd>Back</kbd> button to go back to the session area, and then send a message to the assistant: "What should I wear?" The assistant will try to ask you about your gender and current mood.
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260291-f0aa0e7c-0ffb-486c-a834-08e73d49896f.png)
@@ -83,6 +89,8 @@ After answering, the assistant will make a plugin call to retrieve recommended c
After completing these steps, you have learned the basic process of adding and using a custom plugin in LobeChat.
<br/>
## Local Plugin Development
In the previous workflow, we have learned how to add and use a plugin. Now let's focus on the development process of custom plugins.
@@ -248,15 +256,39 @@ const Render = memo(() => {
export default Render;
```
<br/>
## Plugin Deployment and Publication
After completing the plugin development, you can deploy the plugin using your preferred method. For example, you can use Vercel or package it as a Docker image for publication.
If you want more people to use your plugin, you are welcome to submit it for review in the plugin marketplace.
[![][submit-plugin-shield]][submit-plugin-url]
### Plugin Shield
[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
```markdown
[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
```
<br/>
## Link
- **📘 Pluging SDK Docs**: <https://chat-plugin-sdk.lobehub.com>
- **🚀 chat-plugin-template**: <https://github.com/lobehub/chat-plugin-template>
- **🧩 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-sdk>
- **🚪 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-gateway>
- **🏪 lobe-chat-plugins**: <https://github.com/lobehub/lobe-chat-plugins>
<!-- LINK GROUP -->
[fetch-plugin-message-url]: https://github.com/lobehub/chat-plugin-template
[lobe-chat-plugin-template-url]: https://github.com/lobehub/chat-plugin-template
[manifest-docs-url]: https://github.com/lobehub/chat-plugin-sdk/tree/master/docs/manifest.zh-CN.md
[manifest-docs-url]: https://chat-plugin-sdk.lobehub.com/guides/plugin-manifest
[plugin-error-type-url]: https://github.com/lobehub/chat-plugin-template
[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins
docs/Plugin-Development.zh-CN.md
+53 -21
View File
@@ -6,9 +6,9 @@
- [自定义插件流程](#自定义插件流程)
- [1. 创建并启动插件项目](#1-创建并启动插件项目)
- [2. 在 LobeChat 角色设置中添加本地插件](#2-在-lobechat-角色设置中添加本地插件)
- [3. 会话测试插件功能](#3-会话测试插件功能)
- [**`1`** 创建并启动插件项目](#1-创建并启动插件项目)
- [**`2`** 在 LobeChat 角色设置中添加本地插件](#2-在-lobechat-角色设置中添加本地插件)
- [**`3`** 会话测试插件功能](#3-会话测试插件功能)
- [本地插件开发](#本地插件开发)
@@ -19,23 +19,29 @@
- [插件部署与发布](#插件部署与发布)
- [插件 Shield](#插件-shield)
- [链接](#链接)
## 插件构成
一个 LobeChat 的插件由以下几个部分组成：
1. **插件索引**：用于展示插件的基本信息，包括插件名称、描述、作者、版本、插件描述清单的链接，官方的插件索引地址：[lobe-chat-plugins](https://github.com/lobehub/lobe-chat-plugins)。若想上架插件到官方插件市场，需要[提交 PR](https://github.com/lobehub/lobe-chat-plugins/pulls) 到该仓库；
1. **插件索引**：用于展示插件的基本信息，包括插件名称、描述、作者、版本、插件描述清单的链接，官方的插件索引地址：[lobe-chat-plugins](https://github.com/lobehub/lobe-chat-plugins)。若想上架插件到官方插件市场，需要 [提交 PR](https://github.com/lobehub/lobe-chat-plugins/pulls) 到该仓库；
2. **插件描述清单 (manifest)**：用于描述插件的功能实现，包含了插件的服务端描述、前端展示信息、版本号等。关于 manifest 的详细介绍，详见 [manifest][manifest-docs-url]；
3. **插件服务**：用于实现插件描述清单中所描述的服务端和前端模块，分别如下：
- **服务端**：需要实现 manifest 中描述的 `api` 部分的接口能力；
- **前端 UI**（可选）：需要实现 manifest 中描述的 `ui` 部分的界面，该界面将会在插件消息中透出，进而实现比文本更加丰富的信息展示方式。
<br/>
## 自定义插件流程
本节将会介绍如何在 LobeChat 中添加和使用一个自定义插件。
### 1. 创建并启动插件项目
### **`1`** 创建并启动插件项目
你需要先在本地创建一个插件项目，可以使用我们准备好的模板 [lobe-chat-plugin-template][lobe-chat-plugin-template-url]；
你需要先在本地创建一个插件项目，可以使用我们准备好的模板 [lobe-chat-plugin-template][lobe-chat-plugin-template-url]
```bash
$ git clone https://github.com/lobehub/chat-plugin-template.git
@@ -44,35 +50,35 @@ $ npm i
$ npm run dev
```
当出现 `ready started server on 0.0.0.0:3400, url: http://localhost:3400` 时，说明插件服务已经在本地启动成功。
当出现`ready started server on 0.0.0.0:3400, url: http://localhost:3400` 时，说明插件服务已经在本地启动成功。
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259526-9ef25272-4312-429b-93bc-a95515727ed3.png)
### 2. 在 LobeChat 角色设置中添加本地插件
### **`2`** 在 LobeChat 角色设置中添加本地插件
接下来进入到 LobeChat 中，创建一个新的助手，并进入它的会话设置页：
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259643-1a9cc34a-76f3-4ccf-928b-129654670efd.png)
点击「插件列表」右侧的「添加」按钮，打开自定义插件添加弹窗：
点击插件列表右侧的 <kbd>添加<kbd/> 按钮，打开自定义插件添加弹窗：
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259748-2ef6a244-39bb-483c-b359-f156ffcbe1a4.png)
在 「插件描述文件 Url 地址」中填入 `http://localhost:3400/manifest-dev.json` ，这是我们本地启动的插件描述清单地址。
在 **插件描述文件 Url** 地址 中填入 `http://localhost:3400/manifest-dev.json` ，这是我们本地启动的插件描述清单地址。
此时，你应该可以看到看到插件的标识符一栏已经被自动识别为 `chat-plugin-template`。接下来你需要填写剩下的表单字段（只有标题必填），然后点击「保存」按钮，即可完成自定义插件添加。
此时，你应该可以看到看到插件的标识符一栏已经被自动识别为 `chat-plugin-template`。接下来你需要填写剩下的表单字段（只有标题必填），然后点击 <kbd>保存</kbd> 按钮，即可完成自定义插件添加。
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265259964-59f4906d-ae2e-4ec0-8b43-db36871d0869.png)
完成添加后，在插件列表中就能看到刚刚添加的插件，如果需要修改插件的配置，可以点击最右侧的「设置」按钮进行修改。
完成添加后，在插件列表中就能看到刚刚添加的插件，如果需要修改插件的配置，可以点击最右侧的 <kbd>设置</kbd> 按钮进行修改。
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260093-a0363c74-0b5b-48dd-b103-2db6b4a8262e.png)
### 3. 会话测试插件功能
### **`3`** 会话测试插件功能
接来下我们需要测试这个插件的功能是否正常。
点击「返回」按钮回到会话区，然后向助手发送消息：「我应该穿什么？ 」此时助手将会尝试向你询问，了解你的性别与当前的心情。
点击 <kbd>返回</kbd> 按钮回到会话区，然后向助手发送消息：「我应该穿什么？ 」此时助手将会尝试向你询问，了解你的性别与当前的心情。
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265260291-f0aa0e7c-0ffb-486c-a834-08e73d49896f.png)
@@ -82,15 +88,17 @@ $ npm run dev
当完成这些操作后，你已经了解了添加自定义插件，并在 LobeChat 中使用的基础流程。
<br/>
## 本地插件开发
在上述流程中，我们已经了解插件的添加和使用的方式，接下来重点介绍自定义插件开发的过程。
### manifest
manifest 聚合了插件功能如何实现的信息。核心字段为 `api` 与 `ui`，分别描述了插件的服务端接口能力与前端渲染的界面地址。
`manifest` 聚合了插件功能如何实现的信息。核心字段为 `api` 与 `ui`，分别描述了插件的服务端接口能力与前端渲染的界面地址。
以我们提供的模板中的 manifest 为例：
以我们提供的模板中的 `manifest` 为例：
```json
{
@@ -161,7 +169,7 @@ manifest 聚合了插件功能如何实现的信息。核心字段为 `api` 与
服务端需要实现 manifest 中描述的 api 接口。在模板中，我们使用了 vercel 的 [Edge Runtime](https://nextjs.org/docs/pages/api-reference/edge)，免去运维。
#### api 实现
#### API 实现
针对 Edge Runtime ，我们在 `@lobehub/chat-plugin-sdk` 提供了 `createErrorResponse` 方法，用于快速返回错误响应。目前提供的错误类型详见：[PluginErrorType][plugin-error-type-url]。
@@ -187,9 +195,9 @@ export default async (req: Request) => {
其中 `maniClothes` 和 `womanClothes` 是 mock 数据，在实际场景中，可以替换为数据库查询等。
#### gateway
#### Plugin Gateway
由于 LobeChat 默认的插件网关是云端服务（`/api/plugins`），云端服务通过 manifest 上的 `api.url` 地址发送请求，以解决跨域问题。
由于 LobeChat 默认的插件网关是云端服务 `/api/plugins`，云端服务通过 manifest 上的 `api.url` 地址发送请求，以解决跨域问题。
针对自定义插件，插件请求需要发送给本地服务， 因此通过在 manifest 中指定网关 (<http://localhost:3400/api/gateway>)，LobeChat 将会直接请求该地址，然后只需要在该地址下创建对应的网关即可。
@@ -207,7 +215,7 @@ export default async createLobeChatPluginGateway();
### 插件 UI 界面
自定义插件的 UI 界面是一个可选项。例如 官方插件 [「网页内容提取」](https://github.com/lobehub/chat-plugin-web-crawler)，没有实现相应的用户界面。
自定义插件的 UI 界面是一个可选项。例如 官方插件 [「🧩 / 🕸 网页内容提取」](https://github.com/lobehub/chat-plugin-web-crawler)，没有实现相应的用户界面。
![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265263241-0e765fdc-3463-4c36-a398-aef177a30df9.png)
@@ -247,15 +255,39 @@ const Render = memo(() => {
export default Render;
```
<br/>
## 插件部署与发布
当你完成插件的开发后，你可以使用你习惯的方式进行插件的部署。例如使用 vercel ，或者打包成 docker 发布等等。
如果你希望插件被更多人使用，欢迎将你的插件 [提交上架](https://github.com/lobehub/lobe-chat-plugins) 到插件市场。
[![][submit-plugin-shield]][submit-plugin-url]
### 插件 Shield
[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
```markdown
[![lobe-chat-plugin](https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan)](https://github.com/lobehub/lobe-chat-plugins)
```
<br/>
## 链接
- **📘 Pluging SDK 文档**: <https://chat-plugin-sdk.lobehub.com>
- **🚀 chat-plugin-template**: <https://github.com/lobehub/chat-plugin-template>
- **🧩 chat-plugin-sdk**: <https://github.com/lobehub/chat-plugin-sdk>
- **🚪 chat-plugin-gateway**: <https://github.com/lobehub/chat-plugin-gateway>
- **🏪 lobe-chat-plugins**: <https://github.com/lobehub/lobe-chat-plugins>
<!-- LINK GROUP -->
[fetch-plugin-message-url]: https://github.com/lobehub/chat-plugin-template
[lobe-chat-plugin-template-url]: https://github.com/lobehub/chat-plugin-template
[manifest-docs-url]: https://github.com/lobehub/chat-plugin-sdk/tree/master/docs/manifest.zh-CN.md
[manifest-docs-url]: https://chat-plugin-sdk.lobehub.com/guides/plugin-manifest
[plugin-error-type-url]: https://github.com/lobehub/chat-plugin-template
[submit-plugin-shield]: https://img.shields.io/badge/🧩/🏪_submit_plugin-%E2%86%92-50E3C2?style=for-the-badge
[submit-plugin-url]: https://github.com/lobehub/lobe-chat-plugins
docs/_Sidebar.md
+3
View File
@@ -17,6 +17,7 @@
- [Plugin Index][plugin-index] | [中文][plugin-index-cn]
- [Plugin Development](Plugin-Development) | [中文](Plugin-Development.zh-CN)
- [Plugin SDK Docs][plugin-sdk] | [中文][plugin-skd-cn]
<!-- LINK GROUP -->
@@ -24,3 +25,5 @@
[agent-index-cn]: https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md
[plugin-index]: https://github.com/lobehub/lobe-chat-plugins
[plugin-index-cn]: https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md
[plugin-sdk]: https://chat-plugin-sdk.lobehub.com
[plugin-skd-cn]: https://chat-plugin-sdk.lobehub.com