Skip to content

Commit 28e09aa

Browse files
committed
更新文档
1 parent bde0746 commit 28e09aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+360
-283
lines changed

docs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,6 @@
2424

2525
## 3 致谢贡献者
2626

27-
[点击获取你的贡献者证书,参与社区回馈活动。](https://www.lxware.cn/1panel-contributors#/)
27+
!!! note ""
28+
29+
[点击获取你的贡献者证书,参与社区回馈活动。](https://www.lxware.cn/1panel-contributors#/)

docs/installation/cli.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323
restore 恢复 1Panel 服务及数据
2424
```
2525

26-
## 2 1pctl reset
26+
## 2 1pctl 典型应用说明
27+
28+
### 2.1 1pctl reset
2729

2830
!!! note ""
2931
**重置 1Panel 系统信息,包括取消安全入口登录,取消两步验证等**
@@ -41,7 +43,7 @@
4143
mfa 取消 1Panel 两步验证
4244
```
4345

44-
## 3 1pctl listen-ip
46+
### 2.2 1pctl listen-ip
4547

4648
!!! note ""
4749
**修改 1Panel 监听 IP**
@@ -56,7 +58,7 @@
5658
ipv6 监听 IPv6
5759
```
5860

59-
## 4 1pctl update
61+
### 2.3 1pctl update
6062

6163
!!! note ""
6264
**修改 1Panel 系统信息**
Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,60 @@
1-
## 1. 安装 1panel-migrator
1+
## 1 安装 1panel-migrator
22

33
### 1.1 安装包获取
44

5-
请访问 Gitee 发布页,手动下载适用于您服务器架构的安装包,并将其放置到 `/tmp` 目录:
6-
7-
> 🔗 https://gitee.com/fit2cloud-feizhiyun/1panel-migrator/releases/
8-
9-
**提示**:请确保安装包版本 **大于等于 v2.0.8**,该版本及以上才支持主从节点切换功能。
5+
!!! note ""
106

11-
每个版本会提供以下架构的安装包(文件名示例)
7+
请访问 [1PanelGitee 发布页面](https://gitee.com/fit2cloud-feizhiyun/1panel-migrator/releases/),手动下载适用于您服务器架构的安装包,并将其放置到 `/tmp` 目录
128

13-
- `1panel-migrator-linux-amd64`
14-
- `1panel-migrator-linux-arm64`
15-
- `1panel-migrator-linux-arm`
16-
- `1panel-migrator-linux-ppc64le`
17-
- `1panel-migrator-linux-s390x`
9+
**提示**:请确保安装包版本 **大于等于 v2.0.8**,该版本及以上才支持主从节点切换功能。
10+
11+
每个版本会提供以下架构的安装包(文件名示例):
12+
13+
- `1panel-migrator-linux-amd64`
14+
- `1panel-migrator-linux-arm64`
15+
- `1panel-migrator-linux-arm`
16+
- `1panel-migrator-linux-ppc64le`
17+
- `1panel-migrator-linux-s390x`
1818

19-
### 1.2 安装步骤(以 amd64 架构为例)
19+
### 1.2 安装步骤
2020

21-
```bash
22-
# 1. 进入临时目录
23-
cd /tmp
21+
!!! note ""
2422

25-
# 2. 添加执行权限
26-
chmod +x 1panel-migrator-linux-amd64
23+
以 amd64 架构为例说明 1panel-migrator 的安装步骤:
2724

28-
# 3. 移动至系统 PATH 中并重命名
29-
mv 1panel-migrator-linux-amd64 /usr/local/bin/1panel-migrator
30-
```
25+
```bash
26+
# (1)进入临时目录
27+
cd /tmp
28+
29+
# (2)添加执行权限
30+
chmod +x 1panel-migrator-linux-amd64
31+
32+
# (3)移动至系统 PATH 中并重命名
33+
mv 1panel-migrator-linux-amd64 /usr/local/bin/1panel-migrator
34+
```
3135

32-
## 2. 从节点 -> 主节点
36+
## 2 从节点 -> 主节点
3337

3438
!!! note ""
3539

3640
从节点升级为主节点需要先在原来主节点上设置好主节点备份,仅存在备份文件的主节点支持升级到主节点
3741

38-
1. 打开节点列表,点击上方主节点备份
39-
2. 勾选备份节点,设置自动备份频率及保留份数,保存设置
40-
3. 点击执行备份,查看备份结果
42+
(1)打开节点列表,点击上方主节点备份。
43+
44+
(2)勾选备份节点,设置自动备份频率及保留份数,保存设置。
45+
46+
(3)点击执行备份,查看备份结果。
4147

4248
![img.png](../../img/installation/master_backup.png)
4349

44-
4. 打开需要升级的从节点,通过安装好的 1panel-migrator 执行升级命令 `1panel-migrator promote`
50+
(4)打开需要升级的从节点,通过安装好的 1panel-migrator 执行升级命令 `1panel-migrator promote`
4551

4652
![img.png](../../img/installation/promote.png)
4753

48-
## 3. 主节点 -> 从节点
54+
## 3 主节点 -> 从节点
55+
56+
!!! note ""
4957

50-
1. 打开需要降级的主节点,通过安装好的 1panel-migrator 执行降级命令 `1panel-migrator demote`
58+
打开需要降级的主节点,通过安装好的 1panel-migrator 执行降级命令 `1panel-migrator demote`
5159

5260
![img.png](../../img/installation/demote.png)

docs/installation/online_installation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@
2020
!!! note ""
2121
GitHub release 链接: https://github.com/1Panel-dev/1Panel/releases
2222

23-
执行以下安装脚本,根据命令行提示完成安装。
23+
2424
!!! note ""
25+
26+
执行以下安装脚本,根据命令行提示完成安装。
2527
```bash
2628
bash -c "$(curl -sSL https://resource.fit2cloud.com/1panel/package/v2/quick_start.sh)"
2729
```
@@ -42,8 +44,8 @@
4244
http://目标服务器 IP 地址:目标端口/安全入口
4345
```
4446

45-
- **如果使用的是云服务器,请至安全组开放目标端口。**
46-
- **ssh 登录 1Panel 服务器后,执行 1pctl user-info 命令可获取安全入口(entrance)**
47+
- **如果使用的是云服务器,请在安全组中开放对应的目标端口。**
48+
- **ssh 登录 1Panel 服务器后,执行 `1pctl user-info` 命令可获取安全入口(entrance)**
4749

4850
!!! note ""
4951
安装成功后,可使用 [1pctl](cli.md) 命令行工具来维护 1Panel

docs/installation/v1_migrate.md

Lines changed: 66 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,85 +8,105 @@
88
!!! warning "注意"
99
为确保迁移顺利、安全,请务必在执行前仔细阅读以下内容。
1010

11-
### 建议提前创建快照
11+
### 1 创建快照
1212

13-
为防止意外风险,强烈建议:
13+
!!! note ""
14+
为防止意外风险,强烈建议:
1415

15-
- 登录 **1Panel 控制台 → 面板设置** 页面,手动创建系统快照;
16-
- 或通过云服务商平台创建云主机快照。
16+
- 登录 **1Panel 控制台 → 面板设置** 页面,手动创建系统快照;
17+
- 或通过云服务商平台创建云主机快照。
1718

18-
### V1 版本要求
19+
### 2 版本说明
1920

20-
仅支持 **1Panel `v1.10.29-lts` 及以上版本** 执行迁移操作。
21+
!!! note ""
2122

22-
### 迁移后的 V2 版本
23+
- 仅支持 **1Panel `v1.10.29-lts` 及以上版本** 执行迁移操作。
24+
- 执行迁移后,系统将升级至 **1Panel v2.0.0 版本**
2325

24-
执行迁移后,系统将升级至 **1Panel v2.0.0 版本**
26+
### 3 专业版与许可证
2527

26-
### 专业版与许可证
28+
!!! note ""
2729

28-
- 原有许可证将被清除,统一迁移为 **社区版本**
29-
- V1 的买断许可证无法在 V2 中使用,但可前往 [凌霞官网](https://www.lxware.cn/) 进行升级;
30-
- 许可证导入 V2 前,请先前往 [凌霞官网](https://www.lxware.cn/) 确认是否已成功解绑。
30+
- 原有许可证将被清除,统一迁移为 **社区版本**;
31+
- V1 的买断许可证无法在 V2 中使用,但可前往 [凌霞官网](https://www.lxware.cn/) 进行升级;
32+
- 许可证导入 V2 前,请先前往 [凌霞官网](https://www.lxware.cn/) 确认是否已成功解绑。
3133

32-
### 网站
34+
### 4 升级后数据更新说明
3335

34-
#### 网站主目录迁移
36+
#### 4.1 网站
3537

36-
迁移完成后,**所有网站配置将存放于 `{1Panel 安装目录}/www`**
38+
!!! note ""
3739

38-
> 例如:`/opt/1panel/www`
40+
- **网站主目录迁移**
3941

40-
#### OpenResty 版本
42+
迁移完成后,**所有网站配置将存放于 `{1Panel 安装目录}/www`**,例如:`/opt/1panel/www`
4143

42-
系统将自动升级至 **OpenResty `1.27.1.2-0-1-focal`**
44+
- **OpenResty 版本**
4345

44-
#### OpenResty 主配置文件
46+
系统将自动升级至 **OpenResty `1.27.1.2-0-1-focal`**
4547

46-
由于 `1panel-migrator upgrade website` 会重置 OpenResty 主配置文件,如有自定义修改,请提前备份。
48+
- **OpenResty 主配置文件**
4749

48-
#### PHP 运行环境网站
50+
由于 `1panel-migrator upgrade website` 会重置 OpenResty 主配置文件,如有自定义修改,请提前备份。
4951

50-
- 面板内置的 PHP 环境将被移除;
51-
- **已创建网站中的 PHP 容器不会删除**,将被迁移至 静态网站;
52-
- 后续可创建 V2 版本的 PHP 运行环境,在原网站设置中将迁移的静态网站切换为 PHP 网站。
52+
- **PHP 运行环境网站**
5353

54-
#### 反向代理网站
54+
(1)面板内置的 PHP 环境将被移除;
5555

56-
由于 V2 重构了反代缓存机制,改为每个网站使用独立目录,因此在执行 `1panel-migrator upgrade website` 前,请确认所有网站的反代缓存已关闭。
56+
(2)**已创建网站中的 PHP 容器不会删除**,将被迁移至 静态网站;
5757

58-
### 备份记录
58+
(3)后续可创建 V2 版本的 PHP 运行环境,在原网站设置中将迁移的静态网站切换为 PHP 网站。
5959

60-
出于兼容性考虑:
60+
- **反向代理网站**
6161

62-
- 所有 **V1 的网站、应用和数据库备份记录将被清空**
63-
- 请在迁移完成后重新配置备份策略。
62+
由于 V2 重构了反代缓存机制,改为每个网站使用独立目录,因此在执行 `1panel-migrator upgrade website` 前,请确认所有网站的反代缓存已关闭。
6463

65-
### 主机终端
64+
#### 4.2 备份记录
6665

67-
主机列表、分组和快速命令仅在升级为主节点时迁移;若升级为从节点,这部分数据将不会迁移。
66+
!!! note ""
6867

69-
### 计划任务
68+
出于兼容性考虑:
69+
70+
- 所有 **V1 的网站、应用和数据库备份记录将被清空**;
71+
- 请在迁移完成后重新配置备份策略。
7072

71-
- **计划任务本身会迁移**
72-
- **任务的执行记录不会保留**
73+
#### 4.3 主机终端
7374

74-
### 快照
75+
!!! note ""
7576

76-
由于版本机制差异,**V1 的快照记录无法迁移至 V2**
77+
主机列表、分组和快速命令仅在升级为主节点时迁移;若升级为从节点,这部分数据将不会迁移
7778

78-
### 面板设置
79+
#### 4.4 计划任务
7980

80-
升级完成后,所有节点的面板设置将以当前 V2 主节点的配置为准。
81+
!!! note ""
8182

82-
### WAF 和网站监控
83+
- **计划任务本身会迁移**;
84+
- **任务的执行记录不会保留**。
8385

84-
由于架构升级:
86+
#### 4.5 快照
8587

86-
- **V1 的 WAF 配置与网站监控记录大部分不兼容**,不会被迁移;
87-
- WAF 仅保留:黑白名单、IP组、自定义规则;
88-
- 迁移后请重新配置相关功能。
88+
!!! note ""
8989

90-
### 问题反馈
90+
由于版本机制差异,**V1 的快照记录无法迁移至 V2**。
9191

92-
如果您在使用过程中遇到任何问题或有其他反馈,请在 [1Panel 主仓库](https://github.com/1Panel-dev/1Panel/issues) 提交 Issue。
92+
#### 4.6 面板设置
93+
94+
!!! note ""
95+
96+
升级完成后,所有节点的面板设置将以当前 V2 主节点的配置为准。
97+
98+
#### 4.7 WAF 和网站监控
99+
100+
!!! note ""
101+
102+
由于架构升级:
103+
104+
- **V1 的 WAF 配置与网站监控记录大部分不兼容**,不会被迁移;
105+
- WAF 仅保留:黑白名单、IP组、自定义规则;
106+
- 迁移后请重新配置相关功能。
107+
108+
#### 4.8 问题反馈
109+
110+
!!! note ""
111+
112+
如果您在使用过程中遇到任何问题或有其他反馈,请在 [1Panel 主仓库](https://github.com/1Panel-dev/1Panel/issues) 提交 Issue。

0 commit comments

Comments
 (0)