Skip to content

Commit 58e3706

Browse files
authored
feat: Add tamper-proof documentation (#42)
1 parent 0fc2a14 commit 58e3706

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

docs/user_manual/xpack/tamper.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
!!! note ""
2+
3+
1Panel 网站防篡改功能旨在保护网站免受未经授权的修改或篡改。
4+
5+
💎 **专业版功能**:网站防篡改为 1Panel 专业版专属功能。
6+
7+
## 1 功能概述
8+
9+
!!! note "功能概述"
10+
11+
- 支持通过设置排除、保护规则,适应各种网站目录结构;
12+
- 支持排除、保护模版,针对不同的网站快速设置;
13+
- 支持按照文件结构查看保护状态;
14+
- 支持查看筛选拦截日志。
15+
16+
## 2 功能使用
17+
18+
```bash
19+
以文件目录为例,列举两种规则设置:
20+
index
21+
index.html
22+
404.html
23+
test.ts
24+
log
25+
access.log
26+
err.log
27+
```
28+
29+
30+
!!! note "规则 1"
31+
- 保护文件:.html
32+
- 排除目录:log
33+
- 设置:
34+
- index 目录下 *.html 的文件会被限制创建和删除操作,删除直接不允许操作,创建会生成一个拦截记录;
35+
- index 目录下 test.ts 可以自由删除和创建;
36+
- index 目录下可以自由创建 log 目录,因为该目录名被排除;
37+
- index 目录下不能创建 tmp 目录,因为其未被排除,创建会生成一个拦截记录;
38+
- log 目录以及目录下文件可以自由操作。
39+
40+
41+
!!! note "规则 2:"
42+
43+
- 保护文件:.html ./log/access.log
44+
- 排除目录:log
45+
- 设置:
46+
- 和规则 1 相比,access.log 会被限制不允许删除修改,如果保护文件是具体文件目录,具有最高优先级
47+
- 其他和规则一相同
48+
49+
## 3 说明
50+
51+
!!! note "其他说明"
52+
53+
- 排除目录下所有文件可以自由操作,只是目录下具体路径的保护文件同样会被限制编辑和删除;
54+
- 保护目录下可以自由创建非保护文件以及排除目录,否则会生成一条拦截记录;
55+
- 限制保护目录下保护文件的编辑和删除等操作,限制非排除目录的创建和删除。
56+
57+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ nav:
120120
- 拦截记录: user_manual/xpack/waf/log.md
121121
- 封锁记录: user_manual/xpack/waf/block.md
122122
- 💎节点管理: user_manual/xpack/node.md
123+
- 💎网站防篡改: user_manual/xpack/tamper.md
123124
- 日志审计: user_manual/logs.md
124125
- 面板设置: user_manual/settings.md
125126
- 常见问题:

0 commit comments

Comments
 (0)