mirror of
https://github.com/lobehub/lobehub
synced 2026-04-21 17:47:27 +00:00
📝 docs: Update wiki
This commit is contained in:
canisminor1990
parent
3b5a289190
commit
c65094cd92
10 changed files with 99 additions and 83 deletions
27
.github/workflows/contributor-help.yml
vendored
27
.github/workflows/contributor-help.yml
vendored
|
|
@ -1,27 +0,0 @@
|
|||
name: Contributor Helper
|
||||
|
||||
on:
|
||||
schedule: [{ cron: '0 18 * * *' }]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
contributor:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: actions-cool/contributor-helper@v1
|
||||
with:
|
||||
token: ${{ secrets.GH_TOKEN }}
|
||||
style: 'simple'
|
||||
update-files: 'README.md, README.zh-CN.md'
|
||||
update-places: '<!-- CONTRIBUTION GROUP -->/<!-- CONTRIBUTION END -->, <!-- CONTRIBUTION GROUP -->/<!-- CONTRIBUTION END -->'
|
||||
|
||||
- name: Commit and push if changed
|
||||
run: |-
|
||||
git diff
|
||||
git config --global user.name "lobehubbot"
|
||||
git config --global user.email "i@lobehub.com"
|
||||
git pull
|
||||
git add -A
|
||||
git commit -m "🤖 docs: Auto update contributors" || exit 0
|
||||
git push
|
||||
33
README.md
33
README.md
|
|
@ -112,7 +112,7 @@ LobeChat provides a [self-hosted version][deploy-url] with Vercel. This allows y
|
|||
|
||||
### Keep Updated
|
||||
|
||||
If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available". This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to accurately detect updates. We suggest you redeploy using the following steps, [Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.en-US).
|
||||
If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available". This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to accurately detect updates. We suggest you redeploy using the following steps, [📘 Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync).
|
||||
|
||||
<div align="right">
|
||||
|
||||
|
|
@ -136,10 +136,14 @@ If you have deployed your own project following the one-click deployment steps i
|
|||
|
||||
## 🧩 Plugins
|
||||
|
||||
Plugins provide a means to extend the [Function Calling][fc-url] capabilities of LobeChat. They can be used to introduce new function calls, and even new ways to render message results.
|
||||
Plugins provide a means to extend the [Function Calling][fc-url] capabilities of LobeChat. They can be used to introduce new function calls, and even new ways to render message results. If you are interested in plugin development, please refer to our [📘 Plugin Development Guide](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development) in the Wiki.
|
||||
|
||||
> **Note**\
|
||||
> The plugin system is currently undergoing significant development. You can expect to see it in <https://github.com/lobehub/lobe-chat/issues/97>.
|
||||
> The plugin system is currently undergoing major development. You can learn more in the following issues:
|
||||
>
|
||||
> - [x] [**Plugin Phase 1**](https://github.com/lobehub/lobe-chat/issues/73): Implement separation of the plugin from the main body, split the plugin into an independent repository for maintenance, and realize dynamic loading of the plugin.
|
||||
> - [x] [**Plugin Phase 2**](https://github.com/lobehub/lobe-chat/issues/97): The security and stability of the plugin's use, more accurately presenting abnormal states, the maintainability of the plugin architecture and developer-friendly.
|
||||
> - [ ] [**Plugin Phase 3**](https://github.com/lobehub/lobe-chat/issues/149): Higher-level and more comprehensive customization capabilities, support for plugin authentication and examples.
|
||||
|
||||
- [@lobehub/lobe-chat-plugins][lobe-chat-plugins]: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.
|
||||
- [@lobehub/chat-plugin-sdk][chat-plugin-sdk]: The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.
|
||||
|
|
@ -186,27 +190,7 @@ Contributions of all types are more than welcome, if you are interested in contr
|
|||
[![][submit-agents-shield]][submit-agents-url]
|
||||
[![][submit-plugin-shield]][submit-plugin-url]
|
||||
|
||||
<!-- CONTRIBUTION GROUP -->
|
||||
|
||||
> 📊 Total: <kbd>**5**</kbd>
|
||||
|
||||
<a href="https://github.com/arvinxx" title="arvinxx">
|
||||
<img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/canisminor1990" title="canisminor1990">
|
||||
<img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
|
||||
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/actions-user" title="actions-user">
|
||||
<img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/bropines" title="bropines">
|
||||
<img src="https://avatars.githubusercontent.com/u/57861007?v=4" width="50" />
|
||||
</a>
|
||||
|
||||
<!-- CONTRIBUTION END -->
|
||||
[![][contributors-contrib]][contributors-url]
|
||||
|
||||
<div align="right">
|
||||
|
||||
|
|
@ -250,6 +234,7 @@ This project is [MIT](./LICENSE) licensed.
|
|||
[ci-release-url]: https://github.com/lobehub/lobe-chat/actions?query=workflow%3ARelease%20CI
|
||||
[ci-test-shield]: https://github.com/lobehub/lobe-chat/workflows/Test%20CI/badge.svg
|
||||
[ci-test-url]: https://github.com/lobehub/lobe-chat/actions/workflows/test.yml
|
||||
[contributors-contrib]: https://contrib.rocks/image?repo=lobehub/lobe-chat
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat.svg?style=flat
|
||||
[contributors-url]: https://github.com/lobehub/lobe-chat/graphs/contributors
|
||||
[deploy-button-image]: https://vercel.com/button
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ LobeChat 提供了 Vercel 的 [自托管版本][deploy-url]。这使你可以在
|
|||
|
||||
### 保持更新
|
||||
|
||||
如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
|
||||
如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [📘 LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
|
||||
|
||||
<div align="right">
|
||||
|
||||
|
|
@ -136,10 +136,14 @@ LobeChat 提供了 Vercel 的 [自托管版本][deploy-url]。这使你可以在
|
|||
|
||||
## 🧩 插件体系
|
||||
|
||||
插件提供了扩展 LobeChat [Function Calling][fc-url] 能力的方法。可以用于引入新的 Function Calling，甚至是新的消息结果渲染方式。
|
||||
插件提供了扩展 LobeChat [Function Calling][fc-url] 能力的方法。可以用于引入新的 Function Calling，甚至是新的消息结果渲染方式。如果你对插件开发感兴趣，请在 Wiki 中查阅我们的 [📘 插件开发指引](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development.zh-CN) 。
|
||||
|
||||
> **Note**\
|
||||
> 插件系统目前正在进行重大开发。您可以在 <https://github.com/lobehub/lobe-chat/issues/97> 中了解更多信息。
|
||||
> 插件系统目前正在进行重大开发。您可以在以下 Issues 中了解更多信息:
|
||||
>
|
||||
> - [x] [**插件一期**](https://github.com/lobehub/lobe-chat/issues/73): 实现插件与主体分离，将插件拆分为独立仓库维护，并实现插件的动态加载
|
||||
> - [x] [**插件二期**](https://github.com/lobehub/lobe-chat/issues/97): 插件的安全性与使用的稳定性，更加精准地呈现异常状态，插件架构的可维护性与开发者友好
|
||||
> - [ ] [**插件三期**](https://github.com/lobehub/lobe-chat/issues/149)：更高阶与完善的自定义能力，支持插件鉴权与示例
|
||||
|
||||
- [@lobehub/lobe-chat-plugins][lobe-chat-plugins]：这是 LobeChat 的插件索引。它从该仓库的 index.json 中获取插件列表并显示给用户。
|
||||
- [@lobehub/chat-plugin-sdk][chat-plugin-sdk]：LobeChat 插件 SDK 可帮助您创建出色的 Lobe Chat 插件。
|
||||
|
|
@ -186,27 +190,7 @@ $ pnpm dev
|
|||
[![][submit-agents-shield]][submit-agents-url]
|
||||
[![][submit-plugin-shield]][submit-plugin-url]
|
||||
|
||||
<!-- CONTRIBUTION GROUP -->
|
||||
|
||||
> 📊 Total: <kbd>**5**</kbd>
|
||||
|
||||
<a href="https://github.com/arvinxx" title="arvinxx">
|
||||
<img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/canisminor1990" title="canisminor1990">
|
||||
<img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
|
||||
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/actions-user" title="actions-user">
|
||||
<img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
|
||||
</a>
|
||||
<a href="https://github.com/bropines" title="bropines">
|
||||
<img src="https://avatars.githubusercontent.com/u/57861007?v=4" width="50" />
|
||||
</a>
|
||||
|
||||
<!-- CONTRIBUTION END -->
|
||||
[![][contributors-contrib]][contributors-url]
|
||||
|
||||
<div align="right">
|
||||
|
||||
|
|
@ -250,6 +234,7 @@ This project is [MIT](./LICENSE) licensed.
|
|||
[ci-release-url]: https://github.com/lobehub/lobe-chat/actions?query=workflow%3ARelease%20CI
|
||||
[ci-test-shield]: https://github.com/lobehub/lobe-chat/workflows/Test%20CI/badge.svg
|
||||
[ci-test-url]: https://github.com/lobehub/lobe-chat/actions/workflows/test.yml
|
||||
[contributors-contrib]: https://contrib.rocks/image?repo=lobehub/lobe-chat
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat.svg?style=flat
|
||||
[contributors-url]: https://github.com/lobehub/lobe-chat/graphs/contributors
|
||||
[deploy-button-image]: https://vercel.com/button
|
||||
|
|
|
|||
47
docs/Deploy-with-Azure-OpenAI.md
Normal file
47
docs/Deploy-with-Azure-OpenAI.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# Deploying with Azure OpenAI
|
||||
|
||||
LobeChat supports using \[Azure OpenAI]\[azure-openai-url] as the model service provider for OpenAI. This document will guide you through the configuration of Azure OpenAI.
|
||||
|
||||
#### TOC
|
||||
|
||||
- [Usage Limitations](#usage-limitations)
|
||||
- [Configuration in the Interface](#configuration-in-the-interface)
|
||||
- [Configuration at Deployment](#configuration-at-deployment)
|
||||
|
||||
## Usage Limitations
|
||||
|
||||
Considering development costs (\[#178]\[rfc]), the current version of LobeChat does not fully conform to Azure OpenAI's implementation model. Instead, it adopts a solution based on `openai` that is compatible with Azure OpenAI. This brings about the following limitations:
|
||||
|
||||
- You can only choose one between OpenAI and Azure OpenAI. Once you enable Azure OpenAI, you will not be able to use OpenAI as the model service provider.
|
||||
- LobeChat requires deployment names to be the same as the model names in order to function properly. For example, the deployment name for the `gpt-35-turbo` model must be `gpt-35-turbo`, otherwise LobeChat will not be able to match the model correctly.
|
||||
|
||||
- Due to the complexity of integrating the Azure OpenAI SDK, it is currently impossible to query the model list of configured resources.
|
||||
|
||||
## Configuration in the Interface
|
||||
|
||||
Click on "Operation" - "Settings" in the bottom left corner, switch to the "Language Model" tab and enable the "Azure OpenAI" switch to start using Azure OpenAI.
|
||||
|
||||
|
||||
|
||||
You can fill in the corresponding configuration items as needed:
|
||||
|
||||
- **APIKey**: 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 from the Azure portal.
|
||||
- **Azure Api Version**: The API version of Azure, which follows the YYYY-MM-DD format, refer to the \[latest version]\[azure-api-verion-url].
|
||||
|
||||
After completing the above field configuration, click on "Check". If the prompt says "Check Passed", it means the configuration was successful.
|
||||
|
||||
## 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:
|
||||
|
||||
| Environment Variable | Required | Description | Default Value | Example |
|
||||
| -------------------- | -------- | --------------------------------------------------------------------------------- | ------------------ | --------------------------------------------------------------- |
|
||||
| `USE_AZURE_OPENAI` | Yes | Set this value to `1` to enable Azure OpenAI configuration | - | `1` |
|
||||
| `AZURE_API_KEY` | Yes | This is the API key you applied for on the Azure OpenAI account page | - | `c55168be3874490ef0565d9779ecd5a6` |
|
||||
| `OPENAI_PROXY_URL` | Yes | Azure API address, can be found in the "Keys and Endpoints" section | - | `https://docs-test-001.openai.azure.com` |
|
||||
| `AZURE_API_VERSION` | No | Azure's API version, follows the YYYY-MM-DD format | 2023-08-01-preview | `2023-05-15`, refer to \[latest version]\[azure-api-verion-url] |
|
||||
| `ACCESS_CODE` | No | Add a password to access this service, the password should be 6 digits or letters | - | `awCT74` or `e3@09!` |
|
||||
|
||||
> **Note**\
|
||||
> When you enable `USE_AZURE_OPENAI` on the server side, users will not be able to modify and use the OpenAI key in the front-end configuration.
|
||||
|
|
@ -2,6 +2,12 @@
|
|||
|
||||
LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型服务商，本文将介绍如何配置 Azure OpenAI。
|
||||
|
||||
#### TOC
|
||||
|
||||
- [使用限制](#使用限制)
|
||||
- [在界面中配置](#在界面中配置)
|
||||
- [在部署时配置](#在部署时配置)
|
||||
|
||||
## 使用限制
|
||||
|
||||
从研发成本考虑([#178][rfc])，目前阶段的 LobeChat 并没有 100% 完全符合 Azure OpenAI 的实现模型，采用了以 `openai` 为基座，兼容 Azure OpeAI 的解决方案。因此会带来以下局限性：
|
||||
30
docs/Home.md
30
docs/Home.md
|
|
@ -6,30 +6,50 @@
|
|||
|
||||
<h1>Lobe Chat Wiki</h1>
|
||||
|
||||
LobeChat is a open-source, extensible (Function Calling), high-performance chatbot framework. <br/> It supports one-click free deployment of your private ChatGPT/LLM web application.
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### 🤯 LobeChat
|
||||
|
||||
- [Maintaining Updates with LobeChat Self-Deployment](Upstream-Sync.en-US) | [自部署保持更新](Upstream-Sync.zh-CN)
|
||||
- [Maintaining Updates with LobeChat Self-Deployment](Upstream-Sync) | [自部署保持更新](Upstream-Sync.zh-CN)
|
||||
- [Deploying with Azure OpenAI](Deploy-with-Azure-OpenAI) | [自部署保持更新](Deploy-with-Azure-OpenAI.zh-CN)
|
||||
|
||||
---
|
||||
|
||||
### 🤖 Agents
|
||||
|
||||
- [Agent Index and Submit][agent-index] | [助手索引与提交][agent-index-cn]
|
||||
|
||||
---
|
||||
|
||||
### 🧩 Plugins
|
||||
|
||||
- [Plugin Index and Submit][plugin-index] | [插件索引与提交][plugin-index-cn]
|
||||
- [Plugin Development](Plugin-Development.en-US) | [插件开发](Plugin-Development.zh-CN)
|
||||
- [Plugin Development](Plugin-Development) | [插件开发](Plugin-Development.zh-CN)
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary><h4>📝 License</h4></summary>
|
||||
|
||||
[![][fossa-license-shield]][fossa-license-url]
|
||||
|
||||
</details>
|
||||
|
||||
Copyright © 2023 [LobeHub][profile-url]. <br />
|
||||
This project is [MIT][license-url] licensed.
|
||||
|
||||
<!-- LINK GROUP -->
|
||||
|
||||
[agent-index]: https://github.com/lobehub/lobe-chat-agents
|
||||
[agent-index-cn]: https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md
|
||||
[fc-url]: https://sspai.com/post/81986
|
||||
[fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
|
||||
[fossa-license-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
|
||||
[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
|
||||
[profile-url]: https://github.com/lobehub
|
||||
|
|
|
|||
|
|
@ -161,7 +161,6 @@ manifest 聚合了插件功能如何实现的信息。核心字段为 `api` 与
|
|||
|
||||
服务端需要实现 manifest 中描述的 api 接口。在模板中，我们使用了 vercel 的 [Edge Runtime](https://nextjs.org/docs/pages/api-reference/edge)，免去运维。
|
||||
|
||||
|
||||
#### api 实现
|
||||
|
||||
针对 Edge Runtime ，我们在 `@lobehub/chat-plugin-sdk` 提供了 `createErrorResponse` 方法，用于快速返回错误响应。目前提供的错误类型详见：[PluginErrorType][plugin-error-type-url]。
|
||||
|
|
|
|||
|
|
@ -6,7 +6,8 @@
|
|||
|
||||
#### 🤯 LobeChat
|
||||
|
||||
- [Upstream Sync](Upstream-Sync.en-US) | [中文](Upstream-Sync.zh-CN)
|
||||
- [Upstream Sync](Upstream-Sync) | [中文](Upstream-Sync.zh-CN)
|
||||
- [Deploying with Azure OpenAI](Deploy-with-Azure-OpenAI) | [中文](Deploy-with-Azure-OpenAI.zh-CN)
|
||||
|
||||
#### 🤖 Agents
|
||||
|
||||
|
|
@ -15,7 +16,7 @@
|
|||
#### 🧩 Plugins
|
||||
|
||||
- [Plugin Index][plugin-index] | [中文][plugin-index-cn]
|
||||
- [Plugin Development](Plugin-Development.en-US) | [中文](Plugin-Development.zh-CN)
|
||||
- [Plugin Development](Plugin-Development) | [中文](Plugin-Development.zh-CN)
|
||||
|
||||
<!-- LINK GROUP -->
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue