Skip to content

Commit c536ad9

Browse files
committed
新增迁移工具模块
1 parent a157268 commit c536ad9

File tree

8 files changed

+144
-0
lines changed

8 files changed

+144
-0
lines changed
91.3 KB
Loading
80.8 KB
Loading

docs/img/index/migrate_route.png

28.6 KB
Loading
126 KB
Loading
121 KB
Loading

docs/installation/migrate.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# 迁移工具
2+
3+
## 1 迁移路线
4+
!!! Abstract ""
5+
**注意:v1 版本需先升级至 v1.10.10-lts,再使用迁移工具迁移到 v2.1.0,之后可升级到更高版本。**
6+
![migrate](../img/index/migrate_route.png)
7+
8+
## 2 注意事项
9+
!!! Abstract ""
10+
11+
- **此工具是迁移工具,用以迁移 v1 的数据到 v2,并不是升级工具;**
12+
- **此工具只支持 v1.10.10-lts 的数据迁移到 v2.1.0;**
13+
- **迁移前,请务必检查磁盘空间是否足够,确保导出的数据不会超出磁盘存储空间;**
14+
- **v2.1.0 的环境必须是空环境。**
15+
16+
## 3 迁移工具包下载
17+
!!! Abstract ""
18+
打开[MaxKB 迁移工具下载](https://github.com/1Panel-dev/MaxKB-v1-to-v2-migrator)页面,下载最新版本工具包,并上传至部署服务器。
19+
20+
21+
## 4 迁移操作
22+
### 4.1 Linux/macOS 系统
23+
#### 4.1.1 导出数据
24+
!!! Abstract ""
25+
在 v1 机器上下载 MaxKB-v1-to-v2-migrator-<version\>.zip,解压后进入目录,执行命令导出 v1 数据。
26+
27+
- **由于数据量的原因,导出过程中需要一定的时间。**
28+
- 导出完成后,MaxKB-v1-to-v2-migrator-<version\> 中会生成一个migrate.zip。
29+
- 将 MaxKB-v1-to-v2-migrator-<version\> 复制到 v2 所在的机器上。
30+
```
31+
unzip MaxKB-v1-to-v2-migrator-<version>.zip
32+
33+
cd MaxKB-v1-to-v2-migrator-<version>
34+
35+
bash export_v1_data.sh <v1_container_name>
36+
```
37+
38+
#### 4.1.2 导入数据
39+
!!! Abstract ""
40+
在 v2 机器上,确保 v2.1.0 版本的容器已经启动且为空环境, 专业版和企业版需要在启动后手动导入 license,进入迁移工具目录,执行命令将数据导入 v2。
41+
```
42+
cd MaxKB-v1-to-v2-migrator-<version>
43+
44+
bash import_v2_data.sh <v2_container_name>
45+
46+
```
47+
![导入linux](../img/index/migrate_linux_import.png)
48+
![导入linux](../img/index/migrate_linux_import1.png)
49+
**提示:** 导入成功后,需重启容器。
50+
51+
### 4.2 Windows 系统
52+
#### 4.2.1 操作要求
53+
!!! Abstract ""
54+
支持的操作系统:
55+
56+
- Windows 10
57+
- Windows 11
58+
- Windows Server 2016 及以上版本
59+
60+
!!! Abstract ""
61+
前置条件:
62+
63+
- 已安装 Docker Desktop for Windows;
64+
- MaxKB v1 和 v2 容器正在运行;
65+
- 对于 PowerShell 脚本,需要 PowerShell 5.0 或更高版本。
66+
67+
68+
#### 4.2.2 导出数据
69+
!!! Abstract ""
70+
对于 Windows 系统,MaxKB 提供了 PowerShell 脚本(.ps1)来导出 v1 数据。下载迁移工具并解压,使用终端管理员进入迁移目录,执行命令导出 v1 数据。
71+
72+
- **由于数据量的原因,导出过程中需要一定的时间。**
73+
- 导出完成后,MaxKB-v1-to-v2-migrator-<version\> 中会生成一个migrate.zip。
74+
```
75+
# PowerShell 版本
76+
.\export_v1_data.ps1 -ContainerName <v1_container_name>
77+
```
78+
![导出windows](../img/index/migrate_windows_export.png)
79+
80+
#### 4.2.3 导入数据
81+
!!! Abstract ""
82+
确保 v2.1.0 版本的容器已经启动且为空环境, 使用终端管理员进入迁移工具目录,执行命令将数据导入 v2。
83+
```
84+
#PowerShell 版本
85+
.\import_v2_data.ps1 -ContainerName <v2_container_name>
86+
```
87+
![导出windows](../img/index/migrate_windows_import.png)
88+
89+
#### 4.2.4 注意事项
90+
!!! Abstract ""
91+
92+
1. 确保在包含迁移工具的目录中运行脚本
93+
2. 导入前确保已成功导出数据(migrate.zip 文件存在)
94+
3. 导入完成后建议重启 v2 容器
95+
4. 备份重要数据,以防迁移过程中出现问题
96+
97+
#### 4.2.5 Windows 迁移常见问题
98+
!!! Abstract ""
99+
100+
1. 容器未运行
101+
- 使用 `docker ps` 检查容器状态。
102+
2. 权限不足
103+
- 确保 Docker Desktop 正在运行
104+
- 以管理员身份运行终端
105+
- 使用完整路径运行脚本
106+
3. 文件路径问题
107+
- 确保在包含迁移工具的目录中运行脚本
108+
- 检查 migrate.zip 文件是否存在
109+
110+
111+
## 5 迁移说明
112+
### 5.1 用户
113+
!!! Abstract ""
114+
115+
- admin 账户默认授予系统管理员、工作空间管理员、普通用户权限(X-Pack);
116+
- 除 admin 外,系统用户或其他用户类型迁移后,默认角色为普通用户(X-Pack);
117+
- 用户的【姓名】为空,迁移后,自动将【用户名】作为【姓名】;
118+
- 工作空间内的资源查询依照【姓名】查询。
119+
120+
### 5.2 资源
121+
!!! Abstract ""
122+
123+
- v1 授权给其他成员的应用/知识库,迁移后授予相应的权限;
124+
- 资源创建者拥有管理资源的权限;
125+
- v1 函数库迁移后,在工具中,创建者有管理权限,其他用户默认都是不授权状态;
126+
- 公有模型迁移后,默认资源授权所有普通用户为查看权限,创建者为管理权限。
127+
128+
129+
### 5.3 回调地址与接口
130+
!!! Abstract ""
131+
132+
- 回调地址发生变化,应用接入、登录认证(扫码登录)需重新配置(X-Pack);
133+
- v1 与 v2 的接口文档不一致,如有接口调用,需重新配置。

docs/user_manual/app/workflow_app.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,16 @@
413413

414414
![MCP 节点](../../img/app/mcp.png){width="500px"}
415415

416+
!!! Abstract ""
417+
```
418+
MCP Server Config 格式参考如下
419+
{
420+
"amap-maps": {
421+
"url": "http://IP:端口/MCPserver名称",
422+
"transport":"sse" # 如果使用 Streamable_HTTP 协议,需将"sse"替换成"streamable_http"
423+
}
424+
}
425+
```
416426

417427
#### 2.5.3 自定义工具
418428
!!! Abstract ""

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ nav:
4848
- 1Panel 安装: installation/1panel_installtion.md
4949
#- 阿里云安装: installation/aliyun.md
5050
#- 腾讯云安装: installation/tencent.md
51+
- 迁移工具: installation/migrate.md
5152
- 命令行工具: installation/cli.md
5253
- 功能手册:
5354
- 模型:

0 commit comments

Comments
 (0)