Skip to content

Commit 7d52732

Browse files
linyuiulinyuiu
committed
update docs
1 parent 63dc914 commit 7d52732

40 files changed

+485
-477
lines changed

‎docs/dev_manual/api_manual.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,26 @@
7272

7373
!!! note ""
7474

75-
- 时间戳的有效性:需要确保服务器与客户端时间同步，否则会导致验证失败。建议使用 NTP 同步时间。
76-
- 白名单使用:将可信任的 IP 或 IP 段加入白名单，避免频繁 Token 验证的开销；如需放行所有 IP ，可以配置 `0.0.0.0`。
75+
- 时间戳的有效性:需要确保服务器与客户端时间同步，否则会导致验证失败。建议使用 NTP 同步时间
76+
- 白名单使用:将可信任的 IP 或 IP 段加入白名单，避免频繁 Token 验证的开销；如需放行所有 IP ，可以配置 `0.0.0.0`
7777

7878
## 3 常见问题
7979

8080
!!! note ""
8181

82-
（1）如果 1Panel-Token或1Panel-Timestamp 错误怎么办？
83-
后台将返回 401 Unauthorized，并提示 "API 接口密钥错误"。
82+
- 如果 1Panel-Token 或 1Panel-Timestamp 错误怎么办
8483

85-
（2）如何生成 1Panel-Token？
84+
后台将返回 401 Unauthorized，并提示 "API 接口密钥错误"。
8685

87-
请参考以下伪代码：
88-
89-
```javascript
90-
const token = md5('1panel' + clientToken + unixTimestamp);
91-
```
86+
- 如何生成 1Panel-Token
87+
88+
请参考以下伪代码：
89+
90+
```javascript
91+
const token = md5('1panel' + clientToken + unixTimestamp);
92+
```
9293

93-
（3）为什么需要两个 Header？
94-
提高验证的复杂度，同时增强安全性。
94+
- 为什么需要两个 Header
95+
96+
提高验证的复杂度，同时增强安全性。
9597

‎docs/faq/faq.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
!!! note ""
44
**宝塔是一款被广泛使用的 Linux 面板。与宝塔 Linux 面板相比，1Panel 的特色是开源和现代化。**
55

6-
- 开源：1Panel 强调开源开放，广泛获取社区使用反馈，并快速迭代。
7-
- 现代化：一方面，1Panel 采纳最新的前端技术，并通过精心设计的 UX 交互，为用户提供更好的用户使用体验；另一方面，1Panel 采用主流的容器技术，让 Linux 服务器的运维管理更简单、更安全。
6+
- 开源：1Panel 强调开源开放，广泛获取社区使用反馈，并快速迭代
7+
- 现代化：一方面，1Panel 采纳最新的前端技术，并通过精心设计的 UX 交互，为用户提供更好的用户使用体验；另一方面，1Panel 采用主流的容器技术，让 Linux 服务器的运维管理更简单、更安全
88

9-
详细对比请查看：[1Panel vs. 宝塔面板](https://vsbt.1panel.cn/)
9+
详细对比请查看：[1Panel vs 宝塔面板](https://vsbt.1panel.cn/)
1010

1111
## 2 1Panel 安装包多大？运行时占用系统资源多吗？会影响其他应用吗？
1212

1313
!!! note ""
1414

15-
- 1Panel 基于 Golang 语言编写，可执行文件大小约 40MB、运行时占用系系统内存约 150MB。
16-
- 1Panel 基于 Docker 来部署管理其他应用，对系统的侵入影响非常小。
15+
- 1Panel 基于 Golang 语言编写，可执行文件大小约 40MB、运行时占用系系统内存约 150MB
16+
- 1Panel 基于 Docker 来部署管理其他应用，对系统的侵入影响非常小

‎docs/faq/server_architecture.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,86 @@
11
## 1 s390x 架构
22

3-
### 安装 MySQL
3+
### 1.1 安装 MySQL
44

55
!!! note ""
6-
**由于 MySQL 官方未提供 s390x 架构镜像，所以在应用商店启用 MySQL 前，需要手动修改 MySQL 镜像版本**
6+
**由于 MySQL 官方未提供 s390x 架构镜像，所以在应用商店启用 MySQL 前，需要手动修改 MySQL 镜像版本。**
77

88
!!! note "MySQL 5.7"
99

10-
- 1、下载 s390x 架构最新版本镜像
10+
- 下载 s390x 架构最新版本镜像
1111

1212
```bash
1313
docker pull ibmcom/mysql-s390x:5.7.34
1414
```
1515

16-
- 2、将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
16+
- 将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
1717

1818
```bash
1919
docker tag ibmcom/mysql-s390x:5.7.34 mysql:5.7.42
2020
```
2121

22-
- 3、在应用商店中安装 MySQL，版本选择 5.7.42
22+
- 在应用商店中安装 MySQL，版本选择 5.7.42
2323

2424
!!! note "MySQL 8.0"
2525

26-
- 1、下载 s390x 架构最新版本镜像
26+
- 下载 s390x 架构最新版本镜像
2727

2828
```bash
2929
docker pull ibmcom/mysql-s390x:8.0.25
3030
```
3131

32-
- 2、将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
32+
- 将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
3333

3434
```bash
3535
docker tag ibmcom/mysql-s390x:8.0.25 mysql:8.0.33
3636
```
3737

38-
- 3、在应用商店中安装 MySQL，版本选择 8.0.33
38+
- 在应用商店中安装 MySQL，版本选择 8.0.33
3939

4040
## 2 armv7l 架构
4141

42-
### 安装 MySQL
42+
### 2.1 安装 MySQL
4343

4444
!!! note ""
45-
**由于 MySQL 官方未提供 armv7l 架构镜像，所以在应用商店启用 MySQL 前，需要手动修改 MySQL 镜像版本**
45+
**由于 MySQL 官方未提供 armv7l 架构镜像，所以在应用商店启用 MySQL 前，需要手动修改 MySQL 镜像版本。**
4646

4747
!!! note "MySQL 5.7"
4848

49-
- 1、下载 armv7l 架构最新版本镜像
49+
- 下载 armv7l 架构最新版本镜像
5050

5151
```bash
5252
docker pull biarms/mysql:5.7.33-beta-circleci
5353
```
5454

55-
- 2、将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
55+
- 将镜像重命名为 1Panel 应用商店中使用的 MySQL 版本
5656

5757
```bash
5858
docker tag biarms/mysql:5.7.33-beta-circleci mysql:5.7.42
5959
```
6060

61-
- 3、在应用商店中安装 MySQL，版本选择 5.7.42
61+
- 在应用商店中安装 MySQL，版本选择 5.7.42
6262

6363
!!! note "MySQL 8.0"
6464

6565
**1Panel 当前版本还不支持在 armv7l 架构服务器上安装 MySQL 8.0**
6666

67-
### 安装 OpenResty
67+
### 2.2 安装 OpenResty
6868

6969
!!! note ""
70-
**由于 OpenResty 官方未提供 armv7l 架构镜像，所以在应用商店启用 OpenResty 前，需要手动修改 OpenResty 镜像版本**
70+
**由于 OpenResty 官方未提供 armv7l 架构镜像，所以在应用商店启用 OpenResty 前，需要手动修改 OpenResty 镜像版本。**
7171

7272
!!! note ""
7373

74-
- 1、下载 armv7l 架构最新版本镜像
74+
- 下载 armv7l 架构最新版本镜像
7575

7676
```bash
7777
docker pull imzcc/openresty:1.21.4.1-7-alpine
7878
```
7979

80-
- 2、将镜像重命名为 1Panel 应用商店中使用的 OpenResty 版本
80+
- 将镜像重命名为 1Panel 应用商店中使用的 OpenResty 版本
8181

8282
```bash
8383
docker tag imzcc/openresty:1.21.4.1-7-alpine openresty/openresty:1.21.4.1-7-focal
8484
```
8585

86-
- 3、在应用商店中安装 OpenResty
86+
- 在应用商店中安装 OpenResty

‎docs/index.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
!!! note ""
1212

13-
- **高效管理**：用户可以通过 Web 图形界面轻松管理 Linux 服务器，实现主机监控、文件管理、数据库管理、容器管理等功能；
14-
- **快速建站**：深度集成开源建站软件 WordPress 和 [Halo](https://github.com/halo-dev/halo/)，域名绑定、SSL 证书配置等操作一键搞定；
15-
- **应用商店**：精选上架各类高质量的开源工具和应用软件，协助用户轻松安装并升级；
16-
- **安全可靠**：基于容器管理并部署应用，实现最小的漏洞暴露面，同时提供防火墙和日志审计等功能；
17-
- **一键备份**：支持一键备份和恢复，用户可以将数据备份到各类云端存储介质，永不丢失。
13+
- **高效管理**：用户可以通过 Web 图形界面轻松管理 Linux 服务器，实现主机监控、文件管理、数据库管理、容器管理等功能
14+
- **快速建站**：深度集成开源建站软件 WordPress 和 [Halo](https://github.com/halo-dev/halo/)，域名绑定、SSL 证书配置等操作一键搞定
15+
- **应用商店**：精选上架各类高质量的开源工具和应用软件，协助用户轻松安装并升级
16+
- **安全可靠**：基于容器管理并部署应用，实现最小的漏洞暴露面，同时提供防火墙和日志审计等功能
17+
- **一键备份**：支持一键备份和恢复，用户可以将数据备份到各类云端存储介质，永不丢失
1818

1919
## 2 教学视频
2020

‎docs/installation/master_migrate.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
!!! note ""
3939

40-
从节点升级为主节点需要先在原来主节点上设置好主节点备份，仅存在备份文件的主节点支持升级到主节点
40+
从节点升级为主节点需要先在原来主节点上设置好主节点备份，仅存在备份文件的主节点支持升级到主节点：
4141

4242
（1）打开节点列表，点击上方主节点备份。
4343

@@ -47,7 +47,7 @@
4747

4848
![img.png](../../img/installation/master_backup.png)
4949

50-
（4）打开需要升级的从节点，通过安装好的 1panel-migrator 执行升级命令 `1panel-migrator promote`
50+
（4）打开需要升级的从节点，通过安装好的 1panel-migrator 执行升级命令 `1panel-migrator promote` 。
5151

5252
![img.png](../../img/installation/promote.png)
5353

‎docs/installation/online_installation.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
!!! note ""
44
**安装前请确保您的系统符合安装条件：**
55

6-
- 操作系统：支持主流 Linux 发行版本（基于 Debian / RedHat，包括国产操作系统）；
7-
- 服务器架构：x86_64、aarch64、armv7l、ppc64le、s390x；
8-
- 内存要求：建议可用内存在 1GB 以上；
9-
- 浏览器要求：请使用 Chrome、FireFox、IE10+、Edge等现代浏览器；
10-
- **可访问互联网**。
6+
- 操作系统：支持主流 Linux 发行版本（基于 Debian / RedHat，包括国产操作系统）
7+
- 服务器架构：x86_64、aarch64、armv7l、ppc64le、s390x
8+
- 内存要求：建议可用内存在 1GB 以上
9+
- 浏览器要求：请使用 Chrome、FireFox、IE10+、Edge 等现代浏览器
10+
- **可访问互联网**
1111

1212
!!! note "服务器优惠"
1313
如果你还没有服务器，欢迎通过以下优惠链接选购。
1414

15-
- 阿里云：[专属阿里云特价链接 5.5 折优惠](https://market.aliyun.com/common/dashi/1panel?userCode=kmemb8jp)；
16-
- 腾讯云：[【腾讯云】2核2G3M云服务器7.92元/月起，2000元代金券免费领](https://curl.qcloud.com/dK2muFbM)，更多云产品优惠请点击[此链接](https://curl.qcloud.com/9Ogon25Y)；
15+
- 阿里云：[专属阿里云特价链接 5.5 折优惠](https://market.aliyun.com/common/dashi/1panel?userCode=kmemb8jp)
16+
- 腾讯云：[【腾讯云】2核2G3M云服务器7.92元/月起，2000元代金券免费领](https://curl.qcloud.com/dK2muFbM)，更多云产品优惠请点击[此链接](https://curl.qcloud.com/9Ogon25Y)
1717

1818
## 2 安装部署
1919

@@ -44,8 +44,8 @@
4444
http://目标服务器 IP 地址:目标端口/安全入口
4545
```
4646

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

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

‎docs/installation/v1_migrate.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
由于 V2 版本较 V1 版本有比较大的架构变动，目前不支持从 V1 版本直接在线升级至 V2 版本。
55

6-
1Panel V1 版本的用户，可以使用官方提供的[迁移工具 **1panel-migrator**](https://gitee.com/fit2cloud-feizhiyun/1panel-migrator)，将 1Panel V1 平滑升级至 1Panel V2。
6+
1Panel V1 版本的用户，可以使用官方提供的迁移工具[ **1panel-migrator**](https://gitee.com/fit2cloud-feizhiyun/1panel-migrator)，将 1Panel V1 平滑升级至 1Panel V2。
77

88
!!! warning "注意"
99
为确保迁移顺利、安全，请务必在执行前仔细阅读以下内容。
@@ -13,23 +13,23 @@
1313
!!! note ""
1414
为防止意外风险，强烈建议：
1515

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

1919
### 2 版本说明
2020

2121
!!! note ""
2222

23-
- 仅支持 **1Panel `v1.10.29-lts` 及以上版本** 执行迁移操作。
23+
- 仅支持 **1Panel `v1.10.29-lts` 及以上版本** 执行迁移操作
2424
- 执行迁移后，系统将升级至 **1Panel v2.0.0 版本**
2525

2626
### 3 专业版与许可证
2727

2828
!!! note ""
2929

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

3434
### 4 升级后数据更新说明
3535

@@ -67,8 +67,8 @@
6767

6868
出于兼容性考虑：
6969

70-
- 所有 **V1 的网站、应用和数据库备份记录将被清空**；
71-
- 请在迁移完成后重新配置备份策略。
70+
- 所有 **V1 的网站、应用和数据库备份记录将被清空**
71+
- 请在迁移完成后重新配置备份策略
7272

7373
#### 4.3 主机终端
7474

@@ -80,14 +80,14 @@
8080

8181
!!! note ""
8282

83-
- **计划任务本身会迁移**；
84-
- **任务的执行记录不会保留**。
83+
- **计划任务本身会迁移**
84+
- **任务的执行记录不会保留**
8585

8686
#### 4.5 快照
8787

8888
!!! note ""
8989

90-
由于版本机制差异，**V1 的快照记录无法迁移至 V2**。
90+
由于版本机制差异，**V1 的快照记录无法迁移至 V2。**
9191

9292
#### 4.6 面板设置
9393

@@ -101,9 +101,9 @@
101101

102102
由于架构升级：
103103

104-
- **V1 的 WAF 配置与网站监控记录大部分不兼容**，不会被迁移；
105-
- WAF 仅保留：黑白名单、IP组、自定义规则；
106-
- 迁移后请重新配置相关功能。
104+
- **V1 的 WAF 配置与网站监控记录大部分不兼容**，不会被迁移
105+
- WAF 仅保留：黑白名单、IP组、自定义规则
106+
- 迁移后请重新配置相关功能
107107

108108
#### 4.8 问题反馈
109109

‎docs/user_manual/appstore/installed.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838

3939
点击【卸载】按钮，系统将自动执行卸载过程，删除应用的所有相关资源，包括容器、配置文件等。
4040

41-
- 强制删除：会忽略删除过程中产生的错误并最终删除元数据。
42-
- 删除备份：删除备份列表中的备份文件。
41+
- 强制删除：会忽略删除过程中产生的错误并最终删除元数据
42+
- 删除备份：删除备份列表中的备份文件
4343

4444
![img.png](../../img/app/app_delete.png)
4545
{: .browser-mockup}

‎docs/user_manual/containers/compose.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
!!! note ""
44
提供三种方法可以从 1Panel 部署新 Compose
55

6-
- 编辑： 使用 Web 编辑器定义服务。
7-
- 路径选择： 选择 1Panel 服务中已存在的 docker-compose.yml。
8-
- 编排模版： 选择已存在的编排模版。
6+
- 编辑： 使用 Web 编辑器定义服务
7+
- 路径选择： 选择 1Panel 服务中已存在的 docker-compose.yml
8+
- 编排模版： 选择已存在的编排模版
99

1010
[了解更多容器编排相关的知识](https://docs.docker.com/compose)
1111

@@ -17,9 +17,9 @@
1717
!!! note ""
1818
Compose 按照来源可以区分为三种：
1919

20-
- Apps: 来源于应用商店应用部署；
21-
- 1Panel: 来源于系统编排创建；
22-
- Local: 服务器直接创建。
20+
- Apps: 来源于应用商店应用部署
21+
- 1Panel: 来源于系统编排创建
22+
- Local: 服务器直接创建
2323

2424
**编辑仅适用于 1Panel 部署的 Compose**
2525

‎docs/user_manual/containers/container.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
!!! note ""
44

5-
- 从菜单中选择【容器】，然后单击【创建容器】。
6-
- 根据需要配置容器设置。
7-
- 镜像需要从镜像镜像菜单手动拉取。
5+
- 从菜单中选择【容器】，然后单击【创建容器】
6+
- 根据需要配置容器设置
7+
- 镜像需要从镜像镜像菜单手动拉取
88

99
![img.png](../../img/containers/container_create.png)
1010
{: .original}
@@ -22,7 +22,7 @@
2222

2323
!!! note ""
2424

25-
- 支持查看最近一天，最近 4 小时，最近 1 小时，最近 10 分钟的容器日志。
25+
- 支持查看最近一天，最近 4 小时，最近 1 小时，最近 10 分钟的容器日志
2626
- **追踪：** 实时刷新容器日志
2727
- **下载：** 下载容器日志
2828

@@ -33,7 +33,7 @@
3333

3434
!!! note ""
3535

36-
- 选择要授予访问权限的命令和用户，然后单击【连接】。
36+
- 选择要授予访问权限的命令和用户，然后单击【连接】
3737

3838
**注意：** 对于 Alpine Linux 容器，选择 /bin/ash 命令。如果需要定义除提供的命令之外的命令，请将 **自定义** 选项切换为打开。
3939

0 commit comments

Comments
 (0)