Skip to content

Commit d77a1b2

Browse files
authored
docs: 完善面板设置相关文档 (#22)
1 parent 8a9e996 commit d77a1b2

File tree

3 files changed

+77
-19
lines changed

3 files changed

+77
-19
lines changed

docs/img/settings/panel.png

-236 KB
Loading

docs/img/settings/security.png

-227 KB
Loading

docs/user_manual/settings.md

Lines changed: 77 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,85 @@
22

33
!!! Abstract ""
44
支持面板的一些基础设置,具体包括:
5-
6-
- 用户名称,账户密码: 1Panel 系统仅支持单主机单用户,此处是系统登录的验证信息,在初次登陆时由用户初始化。
7-
- 主题颜色: 系统支持亮色(light)和 暗色(dark),可根据用户使用习惯手动切换。
5+
6+
- 面板用户:1Panel 系统仅支持单主机单用户,此处是用于登录 1Panel 面板的验证信息,在初次登陆时由用户初始化。
7+
- 面板密码:用于登录 1Panel 面板的密码。
8+
- 主题颜色: 系统支持亮色(light)和 暗色(dark),可根据用户使用习惯手动切换,也可以选择跟随系统,根据浏览器及操作系统使用的主题模式自动切换。
9+
- 菜单标签页:开启后,将在页面最上方通过多标签页的方式,列出最近访问过的菜单。
810
- 面板别名: 用户可自定义面板名称。
911
- 系统语言: 系统当前支持中文和英文。
1012
- 超时时间: 此处为系统用户登陆后,多长时间未操作系统自动退出,最小超时时间为 300 秒。
11-
- 服务器时间: 同步服务器时间,时区为默认的东八区,同步服务器为 pool.ntp.org。
13+
- 服务器地址:设置当前服务器的地址,配置后可以点击应用商店已安装应用的服务端口,快速打开指定应用服务页面。
14+
- 代理服务器(✨专业版):配置代理服务器后,1Panel 中的部分网络请求将通过指定的代理服务器进行转发,适合用在内网环境服务器无法直接访问互联网的场景中。
15+
- 预览体验计划:开启后可以获取到 1Panel 的预览版本,以分享有关新功能和更新的反馈。
16+
- 高级功能菜单隐藏:控制是否在左侧菜单中显示高级功能菜单项。
1217

1318
![img.png](../img/settings/panel.png)
1419

1520
## 2 安全
1621

17-
!!! Abstract ""
22+
!!! Abstract "配置说明"
1823
针对一些系统要求等级比较高的用户,我们增加了一些安全设置,具体包括:
1924

20-
- 面板端口: 系统默认的端口为 9999 ,支持端口自定义,但是需要谨慎操作,防止与应用端口冲突导致服务无法启动,建议修改端口前先执行 netstat -tunlp | grep [端口] 查看端口是否正在使用。
25+
- 面板端口:修改 1Panel 服务使用的端口,但是需要谨慎操作,防止与应用端口冲突导致服务无法启动,建议修改端口前先执行 netstat -tunlp | grep [端口] 查看端口是否正在使用。
26+
- 监听地址:修改 1Panel 服务监听的 IP 地址,需谨慎操作,防止监听地址后当前客户端无法访问到面板。
27+
- 安全入口:开启安全入口后只能通过指定安全入口登录面板,同时支持配置是否开启相关提示。
28+
- 未认证设置:配置未使用安全入口访问面板时的返回内容。
29+
- 授权 IP:设置授权 IP 后,仅有设置中的 IP 可以访问 1Panel 服务,支持配置多个 IP 地址。
30+
- 域名绑定:设置域名绑定后,仅能通过设置中域名访问 1Panel 服务。
31+
- 面板 SSL:为面板设置 HTTPS 协议访问,提升面板访问安全性,开启后仅能通过 HTTPS 协议访问 1Panel 服务。
2132
- 密码过期时间: 系统支持设置密码过期天数,默认未设置,当密码超过过期时间时,系统将跳转到改密界面,需要修改账户密码,且新密码不能与老密码相同。
2233
- 密码复杂度校验: 开启后,账户密码必须长度大于 8 位,且包含数字、字母及特殊字符,如 Password@2023。
2334
- 两部校验: 开启 MFA 登录验证,登录时输入用户名密码后,需要手机或者浏览器扫描二维码完成登录,提升系统安全等级。
2435

2536
![img.png](../img/settings/security.png)
2637

38+
!!! warning "注意"
39+
以上设置修改后会影响访问 1Panel 服务的方式,可能导致不能正常打开、登录 1Panel 面板的情况。
40+
41+
此时可以 SSH 登录到服务器后,使用 `1pctl reset` 和 `1pctl update` 命令重置或更新特定配置。
42+
43+
```text
44+
root@hostname:/# 1pctl reset --help
45+
重置系统信息
46+
47+
Usage:
48+
1panel reset [command]
49+
50+
Available Commands:
51+
domain 取消 1Panel 访问域名绑定
52+
entrance 取消 1Panel 安全入口
53+
https 取消 1Panel https 方式登录
54+
ips 取消 1Panel 授权 IP 限制
55+
mfa 取消 1Panel 两步验证
56+
57+
Flags:
58+
-h, --help help for reset
59+
60+
Use "1panel reset [command] --help" for more information about a command.
61+
```
62+
63+
```text
64+
root@hostname:/# 1pctl update
65+
修改面板信息
66+
67+
Usage:
68+
1panel update [command]
69+
70+
Available Commands:
71+
password 修改面板密码
72+
port 修改面板端口
73+
username 修改面板用户
74+
75+
Flags:
76+
-h, --help help for update
77+
78+
Use "1panel update [command] --help" for more information about a command.
79+
```
80+
2781
## 3 备份账号
2882

29-
### 已支持的备份账号
83+
### 3.1 已支持的备份账号
3084

3185
!!! Abstract ""
3286

@@ -40,8 +94,9 @@
4094
- 又拍云 对象存储
4195
- MINIO
4296
- SFTP
97+
- WebDAV
4398

44-
### OneDrive 自定义配置
99+
### 3.2 OneDrive 自定义配置
45100

46101
!!! Abstract ""
47102

@@ -66,7 +121,8 @@
66121
5. 在 API 权限页面选择需要的权限,添加权限,Microsoft Graph,委托的权限,勾选 Files.ReadWrite.All、offline_access、User.Read,这将作为 scope 传递
67122
![img.png](../img/settings/onedrive_custom4.png)
68123

69-
### OneDrive 账号绑定
124+
### 3.3 OneDrive 账号绑定
125+
70126
1. 点击 OneDrive 授权码获取按钮
71127
![img.png](../img/settings/onedrive_step1.png)
72128

@@ -79,7 +135,8 @@
79135
4. 复制授权码到 1Panel 授权码输入框 (注意不要包含 &session_state=xxx 部分)
80136
![img.png](../img/settings/onedrive_step4.png)
81137

82-
### WebDAV 连接 AList
138+
### 3.4 WebDAV 连接 AList
139+
83140
1. 从应用商店安装好 AList 后(记得打开端口外部访问),在容器日志中查看初始化密码,跳转到 AList 管理界面。
84141

85142
2. 存储 菜单中添加对应的存储,记住该路径。
@@ -88,7 +145,7 @@
88145
3. 1Panel 备份账号中,WebDAV 添加该备份账号,这里的路径应该是 /dav/${2步骤中的路径}/xxx,如此处的 /dav/tmp/sftp/1panel,完成绑定。
89146
![img.png](../img/settings/webdav-02.png)
90147

91-
### 部分对象存储服务商与亚马逊 S3 云存储的兼容性
148+
### 3.5 部分对象存储服务商与亚马逊 S3 云存储的兼容性
92149

93150
|服务商|文档|兼容访问风格|兼容性|
94151
| ----- | ---- | ----- | ----- |
@@ -107,13 +164,7 @@
107164
|华为云|文档未说明是否兼容,工单反馈不保证兼容性,实际测试可以使用|Virtual Hosted Style||
108165
|Ucloud|只支持 8MB 大小的分片,本插件暂不支持<br>[https://docs.ucloud.cn/ufile/s3/s3\_introduction](https://docs.ucloud.cn/ufile/s3/s3_introduction)|\-||
109166

110-
111-
## 4 监控
112-
113-
!!! Abstract ""
114-
支持设置是否开启服务器监控和监控日志保留天数
115-
116-
## 5 快照
167+
## 4 快照
117168

118169
!!! Abstract ""
119170

@@ -137,10 +188,17 @@
137188
- 如果上述操作都不能使服务正常运行,则需要手动拿到恢复前的备份文件,手动替换当前系统数据,然后重启系统。
138189
- 如机器迁移等,需要将快照放到备份账号对应的指定目录下,如服务器磁盘:/opt/1panel/backup/system_snapshot/ 。
139190

191+
## 5 许可证
192+
193+
!!! Abstract ""
194+
用于查看当前许可证状态,导入专业版许可证并成功激活后,可以使用专业版相关功能。
195+
196+
[点击了解更多]([专业版详细信息](https://www.lxware.cn/1panel)。)
197+
140198
## 6 关于
141199

142200
!!! Abstract ""
143-
201+
144202
- 支持检查 1Panel 服务是否存在新版本,更新将替换 1panel 二进制文件、1pctl 命令行工具以及 1panel.service 文件。
145203
- 更新失败时,将回滚所有更新内容到更新前的状态,如更新后发现版本信息没有发生变化,则更新失败,可在【面板日志 - 系统日志】中查看失败原因,解决后重新完成更新操作。
146204
![img.png](../img/settings/about.png)

0 commit comments

Comments
 (0)