@lobehub/chat 0.139.0 → 0.139.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/release.yml +2 -0
- package/.github/workflows/test.yml +3 -1
- package/CHANGELOG.md +58 -0
- package/README.md +8 -8
- package/README.zh-CN.md +16 -17
- package/docs/self-hosting/advanced/analytics.mdx +0 -2
- package/docs/self-hosting/advanced/analytics.zh-CN.mdx +0 -2
- package/docs/self-hosting/advanced/authentication.mdx +4 -4
- package/docs/self-hosting/advanced/authentication.zh-CN.mdx +4 -4
- package/docs/self-hosting/advanced/sso-providers/auth0.mdx +11 -11
- package/docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx +11 -11
- package/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx +9 -6
- package/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx +34 -34
- package/docs/self-hosting/advanced/upstream-sync.mdx +5 -3
- package/docs/self-hosting/advanced/upstream-sync.zh-CN.mdx +5 -3
- package/docs/self-hosting/environment-variables/basic.mdx +0 -2
- package/docs/self-hosting/environment-variables/basic.zh-CN.mdx +0 -2
- package/docs/self-hosting/environment-variables.mdx +0 -2
- package/docs/self-hosting/environment-variables.zh-CN.mdx +3 -4
- package/docs/self-hosting/examples/azure-openai.mdx +2 -4
- package/docs/self-hosting/examples/azure-openai.zh-CN.mdx +2 -4
- package/docs/self-hosting/platform/docker-compose.mdx +7 -3
- package/docs/self-hosting/platform/docker-compose.zh-CN.mdx +7 -3
- package/docs/self-hosting/platform/docker.mdx +9 -5
- package/docs/self-hosting/platform/docker.zh-CN.mdx +9 -5
- package/docs/self-hosting/platform/netlify.mdx +12 -14
- package/docs/self-hosting/platform/netlify.zh-CN.mdx +12 -14
- package/docs/self-hosting/platform/repocloud.mdx +0 -2
- package/docs/self-hosting/platform/repocloud.zh-CN.mdx +0 -2
- package/docs/self-hosting/platform/sealos.mdx +0 -2
- package/docs/self-hosting/platform/sealos.zh-CN.mdx +0 -2
- package/docs/self-hosting/platform/vercel.mdx +0 -2
- package/docs/self-hosting/platform/vercel.zh-CN.mdx +0 -2
- package/docs/self-hosting/platform/zeabur.mdx +0 -2
- package/docs/self-hosting/platform/zeabur.zh-CN.mdx +0 -2
- package/docs/usage/agents/concepts.mdx +5 -5
- package/docs/usage/agents/concepts.zh-CN.mdx +2 -2
- package/docs/usage/agents/custom-agent.mdx +13 -8
- package/docs/usage/agents/custom-agent.zh-CN.mdx +12 -6
- package/docs/usage/agents/model.mdx +2 -4
- package/docs/usage/agents/model.zh-CN.mdx +2 -4
- package/docs/usage/agents/prompt.mdx +2 -4
- package/docs/usage/agents/prompt.zh-CN.mdx +2 -4
- package/docs/usage/agents/topics.mdx +1 -1
- package/docs/usage/agents/topics.zh-CN.mdx +1 -1
- package/docs/usage/features/agent-market.mdx +4 -16
- package/docs/usage/features/agent-market.zh-CN.mdx +3 -18
- package/docs/usage/features/local-llm.mdx +1 -3
- package/docs/usage/features/local-llm.zh-CN.mdx +1 -3
- package/docs/usage/features/more.mdx +0 -2
- package/docs/usage/features/more.zh-CN.mdx +0 -2
- package/docs/usage/features/multi-ai-providers.mdx +2 -4
- package/docs/usage/features/multi-ai-providers.zh-CN.mdx +2 -4
- package/docs/usage/features/plugin-system.mdx +3 -13
- package/docs/usage/features/plugin-system.zh-CN.mdx +3 -13
- package/docs/usage/features/pwa.mdx +1 -3
- package/docs/usage/features/pwa.zh-CN.mdx +1 -3
- package/docs/usage/features/text-to-image.mdx +1 -0
- package/docs/usage/features/text-to-image.zh-CN.mdx +1 -0
- package/docs/usage/features/theme.mdx +2 -4
- package/docs/usage/features/theme.zh-CN.mdx +2 -4
- package/docs/usage/features/tts.mdx +7 -2
- package/docs/usage/features/tts.zh-CN.mdx +7 -4
- package/docs/usage/features/vision.mdx +1 -0
- package/docs/usage/features/vision.zh-CN.mdx +1 -0
- package/docs/usage/plugins/basic-usage.mdx +6 -6
- package/docs/usage/plugins/basic-usage.zh-CN.mdx +6 -6
- package/docs/usage/plugins/custom-plugin.mdx +5 -1
- package/docs/usage/plugins/custom-plugin.zh-CN.mdx +5 -1
- package/docs/usage/plugins/development.mdx +32 -32
- package/docs/usage/plugins/development.zh-CN.mdx +32 -32
- package/docs/usage/plugins/store.mdx +3 -3
- package/docs/usage/plugins/store.zh-CN.mdx +3 -3
- package/docs/usage/providers/groq.mdx +44 -0
- package/docs/usage/providers/groq.zh-CN.mdx +42 -0
- package/docs/usage/providers/ollama/gemma.mdx +3 -5
- package/docs/usage/providers/ollama/gemma.zh-CN.mdx +2 -4
- package/docs/usage/providers/ollama.mdx +11 -9
- package/docs/usage/providers/ollama.zh-CN.mdx +10 -11
- package/docs/usage/start.mdx +1 -0
- package/docs/usage/start.zh-CN.mdx +1 -0
- package/package.json +5 -4
- package/src/app/chat/(mobile)/features/ChatInput/index.tsx +1 -0
- package/src/components/ModelProviderIcon/index.tsx +5 -0
- package/src/features/MobileTabBar/index.tsx +2 -1
- package/vercel.json +1 -1
- package/.husky/commit-msg +0 -1
|
@@ -9,6 +9,8 @@ jobs:
|
|
|
9
9
|
|
|
10
10
|
- name: Install bun
|
|
11
11
|
uses: oven-sh/setup-bun@v1
|
|
12
|
+
with:
|
|
13
|
+
bun-version: ${{ secrets.BUN_VERSION }}
|
|
12
14
|
|
|
13
15
|
- name: Install deps
|
|
14
16
|
run: bun i
|
|
@@ -20,4 +22,4 @@ jobs:
|
|
|
20
22
|
run: bun run test:coverage
|
|
21
23
|
|
|
22
24
|
- name: Upload coverage to Codecov
|
|
23
|
-
uses: codecov/codecov-action@
|
|
25
|
+
uses: codecov/codecov-action@v4
|
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,64 @@
|
|
|
2
2
|
|
|
3
3
|
# Changelog
|
|
4
4
|
|
|
5
|
+
### [Version 0.139.2](https://github.com/lobehub/lobe-chat/compare/v0.139.1...v0.139.2)
|
|
6
|
+
|
|
7
|
+
<sup>Released on **2024-03-22**</sup>
|
|
8
|
+
|
|
9
|
+
#### 🐛 Bug Fixes
|
|
10
|
+
|
|
11
|
+
- **misc**: Fix code block display issue.
|
|
12
|
+
|
|
13
|
+
#### 💄 Styles
|
|
14
|
+
|
|
15
|
+
- **misc**: The bottom safe area height of iOS.
|
|
16
|
+
|
|
17
|
+
<br/>
|
|
18
|
+
|
|
19
|
+
<details>
|
|
20
|
+
<summary><kbd>Improvements and Fixes</kbd></summary>
|
|
21
|
+
|
|
22
|
+
#### What's fixed
|
|
23
|
+
|
|
24
|
+
- **misc**: Fix code block display issue, closes [#1675](https://github.com/lobehub/lobe-chat/issues/1675) ([7707dda](https://github.com/lobehub/lobe-chat/commit/7707dda))
|
|
25
|
+
|
|
26
|
+
#### Styles
|
|
27
|
+
|
|
28
|
+
- **misc**: The bottom safe area height of iOS, closes [#1637](https://github.com/lobehub/lobe-chat/issues/1637) [#1181](https://github.com/lobehub/lobe-chat/issues/1181) ([44fae5e](https://github.com/lobehub/lobe-chat/commit/44fae5e))
|
|
29
|
+
|
|
30
|
+
</details>
|
|
31
|
+
|
|
32
|
+
<div align="right">
|
|
33
|
+
|
|
34
|
+
[](#readme-top)
|
|
35
|
+
|
|
36
|
+
</div>
|
|
37
|
+
|
|
38
|
+
### [Version 0.139.1](https://github.com/lobehub/lobe-chat/compare/v0.139.0...v0.139.1)
|
|
39
|
+
|
|
40
|
+
<sup>Released on **2024-03-17**</sup>
|
|
41
|
+
|
|
42
|
+
#### 💄 Styles
|
|
43
|
+
|
|
44
|
+
- **misc**: Improve model tags.
|
|
45
|
+
|
|
46
|
+
<br/>
|
|
47
|
+
|
|
48
|
+
<details>
|
|
49
|
+
<summary><kbd>Improvements and Fixes</kbd></summary>
|
|
50
|
+
|
|
51
|
+
#### Styles
|
|
52
|
+
|
|
53
|
+
- **misc**: Improve model tags ([11cd5f4](https://github.com/lobehub/lobe-chat/commit/11cd5f4))
|
|
54
|
+
|
|
55
|
+
</details>
|
|
56
|
+
|
|
57
|
+
<div align="right">
|
|
58
|
+
|
|
59
|
+
[](#readme-top)
|
|
60
|
+
|
|
61
|
+
</div>
|
|
62
|
+
|
|
5
63
|
## [Version 0.139.0](https://github.com/lobehub/lobe-chat/compare/v0.138.2...v0.139.0)
|
|
6
64
|
|
|
7
65
|
<sup>Released on **2024-03-16**</sup>
|
package/README.md
CHANGED
|
@@ -255,14 +255,14 @@ Our marketplace is not just a showcase platform but also a collaborative space.
|
|
|
255
255
|
|
|
256
256
|
<!-- AGENT LIST -->
|
|
257
257
|
|
|
258
|
-
| Recent Submits
|
|
259
|
-
|
|
|
260
|
-
| [
|
|
261
|
-
| [
|
|
262
|
-
| [
|
|
263
|
-
| [
|
|
264
|
-
|
|
265
|
-
> 📊 Total agents: [<kbd>**
|
|
258
|
+
| Recent Submits | Description |
|
|
259
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
260
|
+
| [Electronic Tutor](https://chat-preview.lobehub.com/market?agent=elec-circuit-tutor-prompt)<br/><sup>By **[XUANJI233](https://github.com/XUANJI233)** on **2024-03-22**</sup> | Specializes in explaining the principles of digital and analog circuits, providing fundamental guidance in electronics.<br/>`electronics` `tutor` `explanation` `circuits` `principles` |
|
|
261
|
+
| [Game Text Translator](https://chat-preview.lobehub.com/market?agent=translation-tutor-prompt)<br/><sup>By **[XUANJI233](https://github.com/XUANJI233)** on **2024-03-22**</sup> | Translation of game text including puns and slang explanations (please use claude). Wrap special symbols with \`\`\`.<br/>`game` `text` `translation` `assistance` |
|
|
262
|
+
| [Amazon Listing Copywriter](https://chat-preview.lobehub.com/market?agent=amazon-listing-copywriter)<br/><sup>By **[SpeedupMaster](https://github.com/SpeedupMaster)** on **2024-03-19**</sup> | Expert in writing persuasive Amazon listings with optimized keywords.<br/>`copywriting` `amazon-product-detail-pages` `seo` `keywords` |
|
|
263
|
+
| [Collaborative Logical Thinking Team](https://chat-preview.lobehub.com/market?agent=gpt-tot)<br/><sup>By **[luciouskami](https://github.com/luciouskami)** on **2024-03-19**</sup> | Using the mind map method, three logical thinking experts collaborate to solve a problem, and present their detailed thought processes in Markdown table format.<br/>`collaboration` `logical-thinking` `solution` |
|
|
264
|
+
|
|
265
|
+
> 📊 Total agents: [<kbd>**213**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
|
|
266
266
|
|
|
267
267
|
<!-- AGENT LIST -->
|
|
268
268
|
|
package/README.zh-CN.md
CHANGED
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
我们是一群充满热情的设计工程师,希望为 AIGC 提供现代化的设计组件和工具,并以开源的方式分享。
|
|
87
87
|
同时通过 Bootstrapping 的方式,我们希望能够为开发者和用户提供一个更加开放、更加透明友好的产品生态。
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
不论普通用户与专业开发者,LobeHub 旨在成为所有人的 AI Agent 实验场。LobeChat 目前正在积极开发中,有任何需求或者问题,欢迎提交 [issues][issues-link]
|
|
90
90
|
|
|
91
91
|
| [![][vercel-shield-badge]][vercel-link] | 无需安装或注册!访问我们的网站,快速体验 |
|
|
92
92
|
| :---------------------------------------- | :--------------------------------------------------------------------------- |
|
|
@@ -167,7 +167,7 @@ LobeChat 已经支持 OpenAI 最新的 [`gpt-4-vision`](https://platform.openai.
|
|
|
167
167
|
|
|
168
168
|
### `4` [TTS & STT 语音会话][docs-feat-tts]
|
|
169
169
|
|
|
170
|
-
LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Speech-to-Text,STT
|
|
170
|
+
LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Speech-to-Text,STT)技术,这使得我们的应用能够将文本信息转化为清晰的语音输出,用户可以像与真人交谈一样与我们的对话助手进行交流。
|
|
171
171
|
用户可以从多种声音中选择,给助手搭配合适的音源。 同时,对于那些倾向于听觉学习或者想要在忙碌中获取信息的用户来说,TTS 提供了一个极佳的解决方案。
|
|
172
172
|
|
|
173
173
|
在 LobeChat 中,我们精心挑选了一系列高品质的声音选项 (OpenAI Audio, Microsoft Edge Speech),以满足不同地域和文化背景用户的需求。用户可以根据个人喜好或者特定场景来选择合适的语音,从而获得个性化的交流体验。
|
|
@@ -182,9 +182,9 @@ LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Spe
|
|
|
182
182
|
|
|
183
183
|
### `5` [Text to Image 文生图][docs-feat-t2i]
|
|
184
184
|
|
|
185
|
-
支持最新的文本到图片生成技术,LobeChat
|
|
185
|
+
支持最新的文本到图片生成技术,LobeChat 现在能够让用户在与助手对话中直接调用文生图工具进行创作。
|
|
186
186
|
通过利用 [`DALL-E 3`](https://openai.com/dall-e-3)、[`MidJourney`](https://www.midjourney.com/) 和 [`Pollinations`](https://pollinations.ai/) 等 AI 工具的能力, 助手们现在可以将你的想法转化为图像。
|
|
187
|
-
|
|
187
|
+
同时可以更私密和沉浸式地完成你的创作过程。
|
|
188
188
|
|
|
189
189
|
<div align="right">
|
|
190
190
|
|
|
@@ -202,7 +202,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地
|
|
|
202
202
|
|
|
203
203
|
通过利用插件,ChatGPT 能够实现实时信息的获取和处理,例如自动获取最新新闻头条,为用户提供即时且相关的资讯。
|
|
204
204
|
|
|
205
|
-
|
|
205
|
+
此外,这些插件不仅局限于新闻聚合,还可以扩展到其他实用的功能,如快速检索文档、生成图象、获取电商平台数据,以及其他各式各样的第三方服务。
|
|
206
206
|
|
|
207
207
|
> 通过文档了解更多 [📘 插件使用][docs-usage-plugin]
|
|
208
208
|
|
|
@@ -243,14 +243,14 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地
|
|
|
243
243
|
|
|
244
244
|
<!-- AGENT LIST -->
|
|
245
245
|
|
|
246
|
-
| 最近新增
|
|
247
|
-
|
|
|
248
|
-
| [
|
|
249
|
-
| [
|
|
250
|
-
| [
|
|
251
|
-
| [
|
|
246
|
+
| 最近新增 | 助手说明 |
|
|
247
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
|
248
|
+
| [电子学导师](https://chat-preview.lobehub.com/market?agent=elec-circuit-tutor-prompt)<br/><sup>By **[XUANJI233](https://github.com/XUANJI233)** on **2024-03-22**</sup> | 擅长数字和模拟电路原理解释,提供电子学基础指导。<br/>`电子学` `导师` `解释` `电路` `原理` |
|
|
249
|
+
| [游戏文本翻译师](https://chat-preview.lobehub.com/market?agent=translation-tutor-prompt)<br/><sup>By **[XUANJI233](https://github.com/XUANJI233)** on **2024-03-22**</sup> | 游戏文本的翻译与双关、俚语解释 (请使用 claude),如果有特殊符号请使用 \`\`\` 包裹<br/>`游戏` `文本` `翻译` `辅助` |
|
|
250
|
+
| [亚马逊清单文案撰稿员](https://chat-preview.lobehub.com/market?agent=amazon-listing-copywriter)<br/><sup>By **[SpeedupMaster](https://github.com/SpeedupMaster)** on **2024-03-19**</sup> | 擅长撰写具有优化关键词的有说服力的亚马逊清单的专家。<br/>`撰稿` `亚马逊产品详情页` `搜索引擎优化` `关键词` |
|
|
251
|
+
| [协作逻辑思维团队](https://chat-preview.lobehub.com/market?agent=gpt-tot)<br/><sup>By **[luciouskami](https://github.com/luciouskami)** on **2024-03-19**</sup> | 使用思维树方法,三位逻辑思维专家协作解答问题,以 Markdown 表格展示。<br/>`协作` `逻辑思维` `解答` |
|
|
252
252
|
|
|
253
|
-
> 📊 Total agents: [<kbd>**
|
|
253
|
+
> 📊 Total agents: [<kbd>**213**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
|
|
254
254
|
|
|
255
255
|
<!-- AGENT LIST -->
|
|
256
256
|
|
|
@@ -264,7 +264,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地
|
|
|
264
264
|
|
|
265
265
|
### `8` [渐进式 Web 应用 (PWA)][docs-feat-pwa]
|
|
266
266
|
|
|
267
|
-
|
|
267
|
+
我们深知在当今多设备环境下为用户提供无缝体验的重要性。为此,我们采用了渐进式 Web 应用 [PWA](https://support.google.com/chrome/answer/9658361) 技术,
|
|
268
268
|
这是一种能够将网页应用提升至接近原生应用体验的现代 Web 技术。通过 PWA,LobeChat 能够在桌面和移动设备上提供高度优化的用户体验,同时保持轻量级和高性能的特点。
|
|
269
269
|
在视觉和感觉上,我们也经过精心设计,以确保它的界面与原生应用无差别,提供流畅的动画、响应式布局和适配不同设备的屏幕分辨率。
|
|
270
270
|
|
|
@@ -299,7 +299,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地
|
|
|
299
299
|
|
|
300
300
|
### `10` [自定义主题][docs-feat-theme]
|
|
301
301
|
|
|
302
|
-
|
|
302
|
+
作为设计工程师出身,LobeChat 在界面设计上充分考虑用户的个性化体验,因此引入了灵活多变的主题模式,其中包括日间的亮色模式和夜间的深色模式。
|
|
303
303
|
除了主题模式的切换,还提供了一系列的颜色定制选项,允许用户根据自己的喜好来调整应用的主题色彩。无论是想要沉稳的深蓝,还是希望活泼的桃粉,或者是专业的灰白,用户都能够在 LobeChat 中找到匹配自己风格的颜色选择。
|
|
304
304
|
|
|
305
305
|
> \[!TIP]
|
|
@@ -314,7 +314,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地
|
|
|
314
314
|
|
|
315
315
|
### 更多特性
|
|
316
316
|
|
|
317
|
-
|
|
317
|
+
除了上述功能特性以外,LobeChat 所具有的设计和技术能力将为你带来更多使用保障:
|
|
318
318
|
|
|
319
319
|
- [x] 💎 **精致 UI 设计**:经过精心设计的界面,具有优雅的外观和流畅的交互效果,支持亮暗色主题,适配移动端。支持 PWA,提供更加接近原生应用的体验。
|
|
320
320
|
- [x] 🗣️ **流畅的对话体验**:流式响应带来流畅的对话体验,并且支持完整的 Markdown 渲染,包括代码高亮、LaTex 公式、Mermaid 流程图等。
|
|
@@ -468,8 +468,7 @@ API Key 是使用 LobeChat 进行大语言模型会话的必要信息,本节
|
|
|
468
468
|
|
|
469
469
|
#### `B` 通过 OpenAI 第三方代理商
|
|
470
470
|
|
|
471
|
-
如果你发现注册 OpenAI 账户或者绑定外币信用卡比较麻烦,可以考虑借助一些知名的 OpenAI 第三方代理商来获取 API Key
|
|
472
|
-
这可以有效降低获取 OpenAI API Key 的门槛。但与此同时,一旦使用三方服务,你可能也需要承担潜在的风险,
|
|
471
|
+
如果你发现注册 OpenAI 账户或者绑定外币信用卡比较麻烦,可以考虑借助一些知名的 OpenAI 第三方代理商来获取 API Key,这可以有效降低获取 OpenAI API Key 的门槛。但与此同时,一旦使用三方服务,你可能也需要承担潜在的风险,
|
|
473
472
|
请根据你自己的实际情况自行决策。以下是常见的第三方模型代理商列表,供你参考:
|
|
474
473
|
|
|
475
474
|
| | 服务商 | 特性说明 | Proxy 代理地址 | 链接 |
|
|
@@ -15,10 +15,10 @@ To simultaneously enable multiple identity verification sources, please set the
|
|
|
15
15
|
|
|
16
16
|
The order corresponds to the display order of the SSO providers.
|
|
17
17
|
|
|
18
|
-
| SSO Provider | Value
|
|
19
|
-
| ------------------ |
|
|
20
|
-
| Auth0 | auth0 |
|
|
21
|
-
| Microsoft Entra ID | azure-ad |
|
|
18
|
+
| SSO Provider | Value |
|
|
19
|
+
| ------------------ | ---------- |
|
|
20
|
+
| Auth0 | `auth0` |
|
|
21
|
+
| Microsoft Entra ID | `azure-ad` |
|
|
22
22
|
|
|
23
23
|
## Other SSO Providers
|
|
24
24
|
|
|
@@ -15,10 +15,10 @@ LobeChat 支持配置外部身份验证服务,供企业 / 组织内部使用
|
|
|
15
15
|
|
|
16
16
|
顺序为 SSO 提供商的显示顺序。
|
|
17
17
|
|
|
18
|
-
| SSO 提供商 | 值
|
|
19
|
-
| ------------------ |
|
|
20
|
-
| Auth0 | auth0 |
|
|
21
|
-
| Microsoft Entra ID | azure-ad |
|
|
18
|
+
| SSO 提供商 | 值 |
|
|
19
|
+
| ------------------ | ---------- |
|
|
20
|
+
| Auth0 | `auth0` |
|
|
21
|
+
| Microsoft Entra ID | `azure-ad` |
|
|
22
22
|
|
|
23
23
|
## 其他 SSO 提供商
|
|
24
24
|
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { Callout, Steps } from 'nextra/components';
|
|
2
|
-
|
|
3
1
|
# Configure Auth0 Identity Verification Service
|
|
4
2
|
|
|
5
3
|
<Steps>
|
|
@@ -7,15 +5,15 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
7
5
|
|
|
8
6
|
Register and log in to [Auth0][auth0-client-page], click on the "Applications" in the left navigation bar to switch to the application management interface, and click "Create Application" in the upper right corner to create an application.
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
<Image alt="Create Auth0 Application S1" inStep src="hhttps://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0" />
|
|
11
9
|
|
|
12
10
|
Fill in the application name you want to display to the organization users, choose any application type, and click "Create".
|
|
13
11
|
|
|
14
|
-
|
|
12
|
+
<Image alt="Create Auth0 Application S2" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d" />
|
|
15
13
|
|
|
16
14
|
After successful creation, click on the corresponding application to enter the application details page, switch to the "Settings" tab, and you can see the corresponding configuration information.
|
|
17
15
|
|
|
18
|
-
|
|
16
|
+
<Image alt="Create Auth0 Application S3" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb" />
|
|
19
17
|
|
|
20
18
|
In the application configuration page, you also need to configure Allowed Callback URLs, where you should fill in:
|
|
21
19
|
|
|
@@ -23,9 +21,9 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
23
21
|
http(s)://your-domain/api/auth/callback/auth0
|
|
24
22
|
```
|
|
25
23
|
|
|
26
|
-
|
|
24
|
+
<Image alt="Create Auth0 Application S4" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/575f46aa-f485-49bd-8b90-dbb1ce1a5c1b" />
|
|
27
25
|
|
|
28
|
-
<Callout type={'
|
|
26
|
+
<Callout type={'important'}>
|
|
29
27
|
You can fill in or modify Allowed Callback URLs after deployment, but make sure the filled URL is
|
|
30
28
|
consistent with the deployed URL.
|
|
31
29
|
</Callout>
|
|
@@ -34,7 +32,7 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
34
32
|
|
|
35
33
|
Click on the "Users Management" in the left navigation bar to enter the user management interface, where you can create users for your organization to log in to LobeChat.
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
<Image alt="Add Users" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc" />
|
|
38
36
|
|
|
39
37
|
### Configure Environment Variables
|
|
40
38
|
|
|
@@ -51,7 +49,9 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
51
49
|
| `ACCESS_CODE` | Required | Add a password to access this service. You can set a sufficiently long random password to "disable" access code authorization. |
|
|
52
50
|
| `NEXTAUTH_URL` | Optional | The URL is used to specify the callback address for the execution of OAuth authentication in Auth.js. It needs to be set only when the default address is incorrect. `https://example.com/api/auth` |
|
|
53
51
|
|
|
54
|
-
<Callout type={'
|
|
52
|
+
<Callout type={'tip'}>
|
|
53
|
+
You can refer to the related variable details at [📘Environment Variables](/en/self-hosting/environment-variable#auth0).
|
|
54
|
+
</Callout>
|
|
55
55
|
</Steps>
|
|
56
56
|
|
|
57
57
|
<Callout>
|
|
@@ -67,13 +67,13 @@ If your enterprise or organization already has a unified identity authentication
|
|
|
67
67
|
|
|
68
68
|
Auth0 supports single sign-on services such as Azure Active Directory, Slack, Google Workspace, Office 365, Zoom, and more. For a detailed list of supported services, please refer to [this link][auth0-sso-integrations].
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
<Image alt="Connecting to an Existing Single Sign-On Service" src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3" />
|
|
71
71
|
|
|
72
72
|
### Configuring Social Login
|
|
73
73
|
|
|
74
74
|
If your enterprise or organization needs to support external user logins, you can configure social login services in Authentication -> Social.
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
<Image alt="Configuring Social Login" src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa" />
|
|
77
77
|
|
|
78
78
|
<Callout type={'warning'}>
|
|
79
79
|
Configuring social login services by default allows anyone to authenticate, which may lead to
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { Callout, Steps } from 'nextra/components';
|
|
2
|
-
|
|
3
1
|
# 配置 Auth0 身份验证服务
|
|
4
2
|
|
|
5
3
|
<Steps>
|
|
@@ -7,15 +5,15 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
7
5
|
|
|
8
6
|
注册并登录 [Auth0][auth0-client-page],点击左侧导航栏的「Applications」,切换到应用管理界面,点击右上角「Create Application」以创建应用。
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
<Image alt="创建 Auth0 应用 S1" inStep src="hhttps://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0" />
|
|
11
9
|
|
|
12
10
|
填写你想向组织用户显示的应用名称,可选择任意应用类型,点击「Create」。
|
|
13
11
|
|
|
14
|
-
|
|
12
|
+
<Image alt="创建 Auth0 应用 S2" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d" />
|
|
15
13
|
|
|
16
14
|
创建成功后,点击相应的应用,进入应用详情页,切换到「Settings」标签页,就可以看到相应的配置信息
|
|
17
15
|
|
|
18
|
-
|
|
16
|
+
<Image alt="创建 Auth0 应用 S3" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb" />
|
|
19
17
|
|
|
20
18
|
在应用配置页面中,还需要配置 Allowed Callback URLs,在此处填写:
|
|
21
19
|
|
|
@@ -23,9 +21,9 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
23
21
|
http(s)://your-domain/api/auth/callback/auth0
|
|
24
22
|
```
|
|
25
23
|
|
|
26
|
-
|
|
24
|
+
<Image alt="创建 Auth0 应用 S4" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/575f46aa-f485-49bd-8b90-dbb1ce1a5c1b" />
|
|
27
25
|
|
|
28
|
-
<Callout type={'
|
|
26
|
+
<Callout type={'important'}>
|
|
29
27
|
可以在部署后再填写或修改 Allowed Callback URLs,但是务必保证填写的 URL 与部署的 URL 一致
|
|
30
28
|
</Callout>
|
|
31
29
|
|
|
@@ -33,7 +31,7 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
33
31
|
|
|
34
32
|
点击左侧导航栏的「Users Management」,进入用户管理界面,可以为你的组织新建用户,用以登录 LobeChat
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
<Image alt="新增用户" inStep src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc" />
|
|
37
35
|
|
|
38
36
|
### 配置环境变量
|
|
39
37
|
|
|
@@ -50,7 +48,9 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
50
48
|
| `ACCESS_CODE` | 必选 | 添加访问此服务的密码,你可以设置一个足够长的随机密码以 “禁用” 访问码授权 |
|
|
51
49
|
| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址,当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` |
|
|
52
50
|
|
|
53
|
-
<Callout type={'
|
|
51
|
+
<Callout type={'tip'}>
|
|
52
|
+
前往 [📘 环境变量](/zh/self-hosting/environment-variable#auth0) 可查阅相关变量详情。
|
|
53
|
+
</Callout>
|
|
54
54
|
</Steps>
|
|
55
55
|
|
|
56
56
|
<Callout type={'info'}>部署成功后,用户将可以使用 Auth0 中配置的用户通过身份认证并使用 LobeChat。</Callout>
|
|
@@ -63,13 +63,13 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
63
63
|
|
|
64
64
|
Auth0 支持 Azure Active Directory / Slack / Google Workspace / Office 365 / Zoom 等单点登录服务,详细支持列表可参考 [这里][auth0-sso-integrations]
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
<Image alt="Connecting to an Existing Single Sign-On Service" src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3" />
|
|
67
67
|
|
|
68
68
|
### 配置社交登录
|
|
69
69
|
|
|
70
70
|
如果你的企业或组织需要支持外部人员登录,可以在 Authentication -> Social 中,配置社交登录服务。
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
<Image alt="Configuring Social Login" src="https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa" />
|
|
73
73
|
|
|
74
74
|
<Callout type={'warning'}>
|
|
75
75
|
配置社交登录服务默认会允许所有人通过认证,这可能会导致 LobeChat 被外部人员滥用。
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
In the `Redirect URI (optional)` section, for the application type, select `Web`, and in the Callback URL, enter:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
https
|
|
13
|
+
https://your-domain/api/auth/callback/azure-ad
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
<Callout type={'info'}>
|
|
@@ -18,19 +18,19 @@
|
|
|
18
18
|
- Please replace "your-domain" with your own domain.
|
|
19
19
|
</Callout>
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
<Image alt="App Register" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d" />
|
|
22
22
|
|
|
23
23
|
Click on "Register".
|
|
24
24
|
|
|
25
25
|
After successfully creating the application, click on the corresponding application to enter the application details page, and switch to the "Overview" tab to view the corresponding configuration information.
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
<Image alt="App Overview" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a" />
|
|
28
28
|
|
|
29
29
|
Go to "Certificates & secrets", select the "Client secrets" tab, click on "New client secret", fill in the description, select the expiration time, and click on "Add" to create a new client secret.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
<Image alt="Create App Client Secret" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2" />
|
|
32
32
|
|
|
33
|
-
<Callout type={'
|
|
33
|
+
<Callout type={'important'}>Please make sure to save your client secret as this is your only chance to view it.</Callout>
|
|
34
34
|
|
|
35
35
|
### Add Users
|
|
36
36
|
|
|
@@ -51,7 +51,10 @@
|
|
|
51
51
|
| `ACCESS_CODE` | Required | Add a password for accessing this service, you can set a sufficiently long random password to "disable" access code authorization. |
|
|
52
52
|
| `NEXTAUTH_URL` | Optional | This URL is used to specify the callback address for Auth.js when performing OAuth authentication. It is only necessary to set it when the default generated redirect address is incorrect. `https://example.com/api/auth` |
|
|
53
53
|
|
|
54
|
-
<Callout type={'
|
|
54
|
+
<Callout type={'tip'}>
|
|
55
|
+
You can refer to [📘 environment variables](/en/self-hosting/environment-variable#microsoft-entra-id) for details on related variables.
|
|
56
|
+
</Callout>
|
|
57
|
+
|
|
55
58
|
</Steps>
|
|
56
59
|
|
|
57
60
|
<Callout>After successful deployment, users will be able to authenticate and use LobeChat using the users configured in Microsoft Entra ID.</Callout>
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { Callout, Steps } from 'nextra/components';
|
|
2
|
-
|
|
3
1
|
# 配置 Microsoft Entra ID 身份验证服务
|
|
4
2
|
|
|
5
3
|
## Microsoft Entra ID 配置流程
|
|
@@ -7,55 +5,57 @@ import { Callout, Steps } from 'nextra/components';
|
|
|
7
5
|
<Steps>
|
|
8
6
|
### 创建 Microsoft Entra ID 应用
|
|
9
7
|
|
|
10
|
-
在你的 [Microsoft Azure Portal][microsoft-azure-portal] 进入 Microsoft Entra ID -> App registrations -> New registration 创建一个新的应用。
|
|
8
|
+
在你的 [Microsoft Azure Portal][microsoft-azure-portal] 进入 Microsoft Entra ID -> App registrations -> New registration 创建一个新的应用。
|
|
11
9
|
|
|
12
|
-
填写你想向组织用户显示的应用名称,选择你期望支持的账户类型,如果只支持内部用户请选择 `Accounts in this organizational directory only (Default Directory only - Single tenant)`。
|
|
10
|
+
填写你想向组织用户显示的应用名称,选择你期望支持的账户类型,如果只支持内部用户请选择 `Accounts in this organizational directory only (Default Directory only - Single tenant)`。
|
|
13
11
|
|
|
14
|
-
在 `Redirect URI (optional)` 中,应用类型选择 `Web`,Callback URL, 处填写:
|
|
12
|
+
在 `Redirect URI (optional)` 中,应用类型选择 `Web`,Callback URL, 处填写:
|
|
15
13
|
|
|
16
|
-
```bash
|
|
17
|
-
https://your-domain/api/auth/callback/azure-ad
|
|
18
|
-
```
|
|
14
|
+
```bash
|
|
15
|
+
https://your-domain/api/auth/callback/azure-ad
|
|
16
|
+
```
|
|
19
17
|
|
|
20
|
-
<Callout type={'info'}>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
</Callout>
|
|
18
|
+
<Callout type={'info'}>
|
|
19
|
+
- 可以在 Register 后再填写或修改 Redirect URIs,但是务必保证填写的 URL 与部署的 URL 一致。
|
|
20
|
+
- your-domain 请填写自己的域名
|
|
21
|
+
</Callout>
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
<Image alt="App Register" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d" />
|
|
26
24
|
|
|
27
|
-
点击「Register」
|
|
25
|
+
点击「Register」
|
|
28
26
|
|
|
29
|
-
创建成功后,点击相应的应用,进入应用详情页,切换到「Overview」标签页,就可以看到相应的配置信息。
|
|
27
|
+
创建成功后,点击相应的应用,进入应用详情页,切换到「Overview」标签页,就可以看到相应的配置信息。
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
<Image alt="App Overview" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a" />
|
|
32
30
|
|
|
33
|
-
进入「Certificates & secrets」,选择「Client secrets」标签,点击「New client secret」,填写描述,选择过期时间,点击「Add」,创建一个新的客户端密钥。
|
|
31
|
+
进入「Certificates & secrets」,选择「Client secrets」标签,点击「New client secret」,填写描述,选择过期时间,点击「Add」,创建一个新的客户端密钥。
|
|
34
32
|
|
|
35
|
-
|
|
33
|
+
<Image alt="Create App Client Secret" inStep src="https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2" />
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
<Callout type={'important'}>请务必保存好你的客户端密钥,因为这是你唯一的机会查看它。</Callout>
|
|
38
36
|
|
|
39
|
-
### 新增用户
|
|
37
|
+
### 新增用户
|
|
40
38
|
|
|
41
|
-
回到「Microsoft Entra ID」界面,进入「Users」,点击「New user」,填写用户信息,点击「Create」,创建用户以使用 LobeChat。
|
|
39
|
+
回到「Microsoft Entra ID」界面,进入「Users」,点击「New user」,填写用户信息,点击「Create」,创建用户以使用 LobeChat。
|
|
42
40
|
|
|
43
|
-
### 配置环境变量
|
|
41
|
+
### 配置环境变量
|
|
44
42
|
|
|
45
|
-
在部署 LobeChat 时,你需要配置以下环境变量:
|
|
43
|
+
在部署 LobeChat 时,你需要配置以下环境变量:
|
|
46
44
|
|
|
47
|
-
| 环境变量
|
|
48
|
-
|
|
|
49
|
-
| `ENABLE_OAUTH_SSO`
|
|
50
|
-
| `NEXTAUTH_SECRET`
|
|
51
|
-
| `SSO_PROVIDERS`
|
|
52
|
-
| `AZURE_AD_CLIENT_ID`
|
|
53
|
-
| `AZURE_AD_CLIENT_SECRET` | 必选 | Microsoft Entra ID 应用程序的 Client Secret
|
|
54
|
-
| `AZURE_AD_TENANT_ID`
|
|
55
|
-
| `ACCESS_CODE`
|
|
56
|
-
| `NEXTAUTH_URL`
|
|
45
|
+
| 环境变量 | 类型 | 描述 |
|
|
46
|
+
| ------------------------ | -- | ------------------------------------------------------------------------------------------- |
|
|
47
|
+
| `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。 |
|
|
48
|
+
| `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥: `openssl rand -base64 32` |
|
|
49
|
+
| `SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Microsoft Entra ID 请填写 `azure-ad`。 |
|
|
50
|
+
| `AZURE_AD_CLIENT_ID` | 必选 | Microsoft Entra ID 应用程序的 Client ID |
|
|
51
|
+
| `AZURE_AD_CLIENT_SECRET` | 必选 | Microsoft Entra ID 应用程序的 Client Secret |
|
|
52
|
+
| `AZURE_AD_TENANT_ID` | 必选 | Microsoft Entra ID 应用程序的 Tenant ID |
|
|
53
|
+
| `ACCESS_CODE` | 必选 | 添加访问此服务的密码,你可以设置一个足够长的随机密码以 “禁用” 访问码授权 |
|
|
54
|
+
| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址,当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` |
|
|
57
55
|
|
|
58
|
-
<Callout type={'
|
|
56
|
+
<Callout type={'tip'}>
|
|
57
|
+
前往 [📘 环境变量](/zh/self-hosting/environment-variable#microsoft-entra-id) 可查阅相关变量详情。
|
|
58
|
+
</Callout>
|
|
59
59
|
</Steps>
|
|
60
60
|
|
|
61
61
|
<Callout type={'info'}>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
# Upstream Sync
|
|
2
2
|
|
|
3
3
|
## `A` Vercel / Zeabur Deployment
|
|
4
4
|
|
|
@@ -16,7 +16,9 @@ If you deployed your project according to the one-click deployment steps in the
|
|
|
16
16
|
|
|
17
17
|
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.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
<Image alt="Enable Automatic Updates S1" src="https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png" />
|
|
20
|
+
|
|
21
|
+
<Image alt="Enable Automatic Updates S2" src="https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png" />
|
|
20
22
|
|
|
21
23
|
## `B` Docker Deployment
|
|
22
24
|
|
|
@@ -56,7 +58,7 @@ Upgrading the Docker deployment version is very simple, you just need to redeplo
|
|
|
56
58
|
|
|
57
59
|
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.
|
|
58
60
|
|
|
59
|
-
<Callout type={'
|
|
61
|
+
<Callout type={'tip'}>
|
|
60
62
|
**If I redeploy, will I lose my local chat records?**
|
|
61
63
|
|
|
62
64
|
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.
|