Skip to content

Commit 90dea18

Browse files
committed
更新迁移工具说明
1 parent c536ad9 commit 90dea18

File tree

2 files changed

+53
-59
lines changed

2 files changed

+53
-59
lines changed
1.06 MB
Loading

docs/installation/migrate.md

Lines changed: 53 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
11
# 迁移工具
22

3-
## 1 迁移路线
3+
## 1 迁移说明
4+
5+
### 1.1 迁移路线
46
!!! Abstract ""
5-
**注意:v1 版本需先升级至 v1.10.10-lts,再使用迁移工具迁移到 v2.1.0,之后可升级到更高版本。**
7+
**注意:v1 版本需先升级至 v1.10.10-lts,再使用迁移工具迁移到 v2.1.0,之后可升级到 v2 更高版本。**
8+
69
![migrate](../img/index/migrate_route.png)
710

8-
## 2 注意事项
11+
### 1.2 注意事项
912
!!! Abstract ""
1013

11-
- **此工具是迁移工具,用以迁移 v1 的数据到 v2,并不是升级工具;**
14+
- **此工具是迁移工具,用以将 v1.10.10-lts 的数据迁移到 v2.1.0,并不是直接的升级工具;**
1215
- **此工具只支持 v1.10.10-lts 的数据迁移到 v2.1.0;**
13-
- **迁移前,请务必检查磁盘空间是否足够,确保导出的数据不会超出磁盘存储空间;**
14-
- **v2.1.0 的环境必须是空环境。**
16+
- **数据迁移的目标环境 必须是v2.1.0,且没有任何数据(license 除外);**
17+
- **迁移前,停止在 v1.10.10 环境进行操作,避免数据迁移不完整;**
18+
- **迁移前,请务必检查磁盘空间,并确保数据导出和导入前后有足够的存储空间。**
1519

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

20-
21-
## 4 迁移操作
22-
### 4.1 Linux/macOS 系统
23-
#### 4.1.1 导出数据
24+
## 3 迁移操作
25+
### 3.1 Linux/macOS 系统
26+
#### 3.1.1 导出数据
2427
!!! Abstract ""
25-
在 v1 机器上下载 MaxKB-v1-to-v2-migrator-<version\>.zip,解压后进入目录,执行命令导出 v1 数据。
28+
在 v1.10.10 机器上下载 MaxKB-v1-to-v2-migrator-<version\>.zip,解压后进入目录,执行命令导出 v1 数据。
2629

27-
- **由于数据量的原因,导出过程中需要一定的时间。**
30+
- 如果迁移数据量较大,导出过程中需要一定的时间,请务必耐心等待。
2831
- 导出完成后,MaxKB-v1-to-v2-migrator-<version\> 中会生成一个migrate.zip。
29-
- 将 MaxKB-v1-to-v2-migrator-<version\> 复制到 v2 所在的机器上。
32+
- 将 MaxKB-v1-to-v2-migrator-<version\> 复制到 v2.1.0 所在的机器上。
3033
```
3134
unzip MaxKB-v1-to-v2-migrator-<version>.zip
3235

@@ -35,21 +38,29 @@
3538
bash export_v1_data.sh <v1_container_name>
3639
```
3740

38-
#### 4.1.2 导入数据
41+
![v1数据导出](../img/index/migrate_linux_export.png)
42+
43+
44+
#### 3.1.2 导入数据
3945
!!! Abstract ""
40-
在 v2 机器上,确保 v2.1.0 版本的容器已经启动且为空环境, 专业版和企业版需要在启动后手动导入 license,进入迁移工具目录,执行命令将数据导入 v2。
46+
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据, 专业版和企业版需要在导入 license 再进行数据的导入。
47+
进入迁移工具目录,执行以下命令将数据导入 v2.1.0。
4148
```
4249
cd MaxKB-v1-to-v2-migrator-<version>
4350

4451
bash import_v2_data.sh <v2_container_name>
4552

4653
```
47-
![导入linux](../img/index/migrate_linux_import.png)
48-
![导入linux](../img/index/migrate_linux_import1.png)
49-
**提示:** 导入成功后,需重启容器。
54+
55+
![导入linux](../img/index/migrate_linux_import.png)
56+
57+
!!! Abstract ""
58+
导入成功后,需要重启 maxkb 服务。
59+
![导入linux](../img/index/migrate_linux_import1.png)
60+
5061

51-
### 4.2 Windows 系统
52-
#### 4.2.1 操作要求
62+
### 3.2 Windows 系统
63+
#### 3.2.1 操作要求
5364
!!! Abstract ""
5465
支持的操作系统:
5566

@@ -65,59 +76,39 @@
6576
- 对于 PowerShell 脚本,需要 PowerShell 5.0 或更高版本。
6677

6778

68-
#### 4.2.2 导出数据
79+
#### 3.2.2 导出数据
6980
!!! Abstract ""
70-
对于 Windows 系统,MaxKB 提供了 PowerShell 脚本(.ps1)来导出 v1 数据。下载迁移工具并解压,使用终端管理员进入迁移目录,执行命令导出 v1 数据。
81+
对于 Windows 系统,MaxKB 提供了 PowerShell 脚本(.ps1)来导出 v1.10.10 数据。下载迁移工具并解压,使用终端管理员进入迁移目录,执行命令导出 v1 数据。
7182

72-
- **由于数据量的原因,导出过程中需要一定的时间**
83+
- 如果迁移数据量较大,导出过程中需要一定的时间,请务必耐心等待。
7384
- 导出完成后,MaxKB-v1-to-v2-migrator-<version\> 中会生成一个migrate.zip。
7485
```
7586
# PowerShell 版本
7687
.\export_v1_data.ps1 -ContainerName <v1_container_name>
7788
```
78-
![导出windows](../img/index/migrate_windows_export.png)
7989

80-
#### 4.2.3 导入数据
90+
![导出windows](../img/index/migrate_windows_export.png)
91+
92+
#### 3.2.3 导入数据
8193
!!! Abstract ""
82-
确保 v2.1.0 版本的容器已经启动且为空环境, 使用终端管理员进入迁移工具目录,执行命令将数据导入 v2
94+
在 v2.1.0 机器上,确保 v2.1.0 版本的容器已经启动且没有任何其它数据, 专业版和企业版需要在导入 license 再进行数据的导入
8395
```
8496
#PowerShell 版本
8597
.\import_v2_data.ps1 -ContainerName <v2_container_name>
8698
```
87-
![导出windows](../img/index/migrate_windows_import.png)
88-
89-
#### 4.2.4 注意事项
90-
!!! Abstract ""
9199

92-
1. 确保在包含迁移工具的目录中运行脚本
93-
2. 导入前确保已成功导出数据(migrate.zip 文件存在)
94-
3. 导入完成后建议重启 v2 容器
95-
4. 备份重要数据,以防迁移过程中出现问题
100+
![导出windows](../img/index/migrate_windows_import.png)
96101

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 用户
102+
## 4 迁移变更说明
103+
### 4.1 用户
113104
!!! Abstract ""
114105

106+
- 如果用户的【姓名】为空,迁移后,自动将【用户名】作为【姓名】;
107+
- 工作空间内的资源查询依照【姓名】查询;
115108
- admin 账户默认授予系统管理员、工作空间管理员、普通用户权限(X-Pack);
116-
- 除 admin 外,系统用户或其他用户类型迁移后,默认角色为普通用户(X-Pack);
117-
- 用户的【姓名】为空,迁移后,自动将【用户名】作为【姓名】;
118-
- 工作空间内的资源查询依照【姓名】查询。
109+
- 除 admin 外,系统用户或其他用户类型迁移后,默认角色为普通用户(X-Pack)。
119110

120-
### 5.2 资源
111+
### 4.2 资源
121112
!!! Abstract ""
122113

123114
- v1 授权给其他成员的应用/知识库,迁移后授予相应的权限;
@@ -126,8 +117,11 @@
126117
- 公有模型迁移后,默认资源授权所有普通用户为查看权限,创建者为管理权限。
127118

128119

129-
### 5.3 回调地址与接口
120+
### 4.3 接口
130121
!!! Abstract ""
131122

132-
- 回调地址发生变化,应用接入、登录认证(扫码登录)需重新配置(X-Pack);
133-
- v1 与 v2 的接口文档不一致,如有接口调用,需重新配置。
123+
- v1 与 v2 的接口文档不一致,如有接口调用,需重新配置;
124+
125+
### 4.4 应用接入
126+
127+
- 应用接入到企业微信等的回调地址会发生变化,应用接入、登录认证(扫码登录)需重新配置(X-Pack);

0 commit comments

Comments
 (0)