Skip to content

Commit 4fb659d

Browse files
committed
API Key对话
1 parent 509f1df commit 4fb659d

File tree

4 files changed

+20
-16
lines changed

4 files changed

+20
-16
lines changed

docs/installation/migrate.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@
44

55
### 1.1 迁移路线
66
!!! Abstract ""
7-
**注意:v1 版本需先升级至 v1.10.10-lts,再使用迁移工具迁移到 v2.1.0之后可升级到 v2 更高版本。**
7+
**注意**:v1 版本需先升级至 **v1.10.10-lts**,再使用迁移工具迁移到 **v2.1.0**。迁移的 v2 版本为 **v2.1.0** ,之后可升级到 v2 更高版本。
88

99
![migrate](../img/index/migrate_route.png)
1010

1111
### 1.2 注意事项
1212
!!! Abstract ""
1313

14-
- **此工具是迁移工具,用以将 v1.10.10-lts 的数据迁移到 v2.1.0,并不是直接的升级工具;**
15-
- **此工具只支持 v1.10.10-lts 的数据迁移到 v2.1.0;**
16-
- **数据迁移的目标环境必须是v2.1.0,且没有任何数据(license 除外);**
17-
- **迁移前,停止在 v1.10.10-lts 环境进行操作,避免数据迁移不完整;**
18-
- **迁移前,请务必检查磁盘空间,并确保数据导出和导入前后有足够的存储空间。**
14+
- 此工具是迁移工具,用以将 v1.10.10-lts 的数据迁移到 v2.1.0,并不是直接的升级工具;
15+
- 此工具只支持 v1.10.10-lts 的数据迁移到 v2.1.0;
16+
- 数据迁移的目标环境必须是 v2.1.0,且没有任何数据(license 除外);
17+
- 迁移前,不要在 v1.10.10-lts 环境进行操作,避免数据迁移不完整;
18+
- 迁移前,请务必检查磁盘空间,并确保数据导出和导入前后有足够的存储空间;
19+
- 迁移时,保证 v1 和 v2 的容器都处于正常运行状态(不需要停止服务)。
1920

2021
## 2 迁移工具下载
2122
!!! Abstract ""
22-
打开[MaxKB 迁移工具下载](https://github.com/1Panel-dev/MaxKB-v1-to-v2-migrator)页面,下载最新版本工具,并上传至部署服务器。
23+
打开 [MaxKB 迁移工具下载](https://github.com/1Panel-dev/MaxKB-v1-to-v2-migrator)页面,下载最新版本工具,并上传至部署服务器。
2324

2425
## 3 迁移操作
2526
### 3.1 Linux/macOS 系统
@@ -29,7 +30,7 @@
2930

3031
- 如果 v1 的数据量较大,导出过程中需要一定的时间,请务必耐心等待。
3132
- 导出完成后,MaxKB-v1-to-v2-migrator-<version\> 中会生成一个 migrate.zip。
32-
- 将 MaxKB-v1-to-v2-migrator-<version\> 复制到 v2.1.0 所在的机器上。
33+
3334
```
3435
unzip MaxKB-v1-to-v2-migrator-<version>.zip
3536

@@ -40,10 +41,13 @@
4041

4142
![v1数据导出](../img/index/migrate_linux_export.png)
4243

44+
!!! Abstract ""
45+
将 MaxKB-v1-to-v2-migrator-<version\> 复制到 v2.1.0 所在的机器上。
46+
4347

4448
#### 3.1.2 导入数据
4549
!!! Abstract ""
46-
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据, 专业版和企业版需导入 license 后再进行数据的导入
50+
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据。
4751

4852
进入迁移工具目录,执行以下命令将数据导入 v2.1.0。
4953
```
@@ -56,7 +60,7 @@
5660
![导入linux](../img/index/migrate_linux_import.png)
5761

5862
!!! Abstract ""
59-
导入成功后,需要重启 maxkb 服务。
63+
导入成功后,需要重启 MaxKB 服务。
6064
![导入linux](../img/index/migrate_linux_import1.png)
6165

6266

@@ -92,7 +96,7 @@
9296

9397
#### 3.2.3 导入数据
9498
!!! Abstract ""
95-
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据,专业版和企业版需要在导入 license 再进行数据的导入
99+
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据。
96100
```
97101
#PowerShell 版本
98102
.\import_v2_data.ps1 -ContainerName <v2_container_name>

docs/user_manual/app/workflow_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@
401401

402402
节点设置:
403403

404-
- MCP Server Config:支持引用 MCP ,也支持自定义 MCP 服务(使用 JSON 格式填写 MCP Server 配置参数)。
404+
- MCP Server Config:支持引用 MCP也支持自定义 MCP 服务(使用 JSON 格式填写 MCP Server 配置参数)。
405405
- 工具:对应 MCP Server下的工具列表。
406406

407407
工具参数:MCP 工具对应的请求参数,可自定义,也可引用变量。

docs/user_manual/chat_to_API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
```
1414
# 将 url 和 Authorization 替换为 MaxKB 应用实际真实的 Base URL 和 API Key。
1515

16-
curl https://maxkb.fit2cloud.com/chat/api/xxxxxxxx-3fdf-7941-a6f4-0572478f57f6 \
17-
-H "Content-Type: application/json" \
18-
-H "Authorization: Bearer application-xxxxxxxxxx987f1bc06ab16e0ef" \
16+
curl https://maxkb.fit2cloud.com/chat/api/xxxxxxxx-3fdf-7941-a6f4-0572478f57f6/chat/completions \
17+
-H "Content-Type: application/json" \
18+
-H "Authorization: Bearer application-xxxxxxxxxx987f1bc06ab16e0ef" \
1919
-d '{
2020
"model": "gpt-3.5-turbo",
2121
"messages": [

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ nav:
8888
- 高级编排应用: user_manual/app/workflow_app.md
8989
- 应用概览: user_manual/app/app-view.md
9090
- 对话日志: user_manual/app/log.md
91-
- 通过API KEY进行对话: user_manual/chat_to_API.md
9291
- 用户管理: user_manual/user_community.md
9392
- 资源授权: user_manual/X-Pack/authorization_resources.md
9493
- 系统设置: user_manual/email.md
@@ -121,6 +120,7 @@ nav:
121120
- 知识库: faq/knowledge_base.md
122121
- 应用: faq/apply_setting.md
123122
- 实践教程:
123+
- 通过 API KEY 进行对话: user_manual/chat_to_API.md
124124
- Ollama 离线部署 LLM 模型: faq/Offline_install_OllamaModel.md
125125
- Ollama 使用 GPU 运行 LLM 模型: faq/GPU_runOllama.md
126126
- 将 MaxKB 小助手集成到 Halo 中: faq/maxkb_In_halo.md

0 commit comments

Comments
 (0)