Pārlūkot izejas kodu

docs: Add description for rule

zu1k 4 gadi atpakaļ
vecāks
revīzija
204ffb7453
5 mainītis faili ar 40 papildinājumiem un 18 dzēšanām
  1. 1 11
      docs/README.md
  2. 2 1
      docs/_sidebar.md
  3. 5 5
      docs/guide/0_cert.md
  4. 12 0
      docs/others.md
  5. 20 1
      docs/rule/README.md

+ 1 - 11
docs/README.md

@@ -6,14 +6,4 @@
 [![Build](https://github.com/zu1k/good-mitm/actions/workflows/build.yml/badge.svg)](https://github.com/zu1k/good-mitm/actions/workflows/build.yml)
 [![GitHub license](https://img.shields.io/github/license/zu1k/good-mitm)](https://github.com/zu1k/good-mitm/blob/master/LICENSE)
 
-Use MITM technology to provide features like `rewrite`, `redirect`, `reject`.
-
-## Thanks
-
-- [**hudsucker**](https://github.com/omjadas/hudsucker): a Rust crate providing MITM features
-
-## License
-
-MIT License
-
-Copyright (c) 2021 zu1k
+使用MITM技术来提供 `rewrite`、`redirect`、`reject` 等功能

+ 2 - 1
docs/_sidebar.md

@@ -3,4 +3,5 @@
   * [证书准备](guide/0_cert.md)
 * [Rule 规则](rule/README.md)
   * [Filter 筛选器](rule/filter.md)
-  * [Action 动作](rule/action.md)
+  * [Action 动作](rule/action.md)
+* [其他](others.md)

+ 5 - 5
docs/guide/0_cert.md

@@ -1,17 +1,17 @@
 # 证书准备
 
-### Certificate Preparation
+为了实现对HTTPS流量进行MITM,同时为了浏览器等不显示安全警告,需要生成并信任自签名CA证书
 
-For MITM functionality, it is required that you trust the self-signed root certificate.
+## 生成CA证书
 
-#### Generate your own root certificate
+处于安全考虑,用户必须自己生成自己的CA证书,随意使用不可信的CA证书将会留下严重的安全隐患
 
-For security reasons, you need to generate your own root certificate.
+经验丰富的用户可以自行使用OpenSSL进行相关操作,考虑到没有相关经验的用户,可以使用以下命令直接生成相关内容,生成的证书和私钥将存储在`ca`目录下
 
 ```shell
 good-mitm.exe genca
 ```
 
-#### Trust your root certificate
+## 信任生成的证书
 
 You need to trust the root certificate just generated, either by adding trust in your browser or in your operating system's root certificate list, as you wish.

+ 12 - 0
docs/others.md

@@ -0,0 +1,12 @@
+# 其他
+
+## 开源证书
+
+MIT License
+
+Copyright (c) 2021 zu1k
+
+## 感谢列表
+
+- [**hudsucker**](https://github.com/omjadas/hudsucker): a Rust crate providing MITM features
+

+ 20 - 1
docs/rule/README.md

@@ -1,3 +1,22 @@
 # Rule 规则
 
-Rule用来操控Good-MITM
+`Rule`用来操控 Good-MITM
+
+一条合格的规则需要包含以下内容:
+
+- `规则名`:用来区分不同的规则,便与维护
+- [`筛选器`](rule/filter.md):用于从众多`请求`和`返回`中筛选出需要处理的内容
+- [`动作`](rule/action.md):用于执行想要的行为,包括`重定向`、`阻断`、`修改`等
+
+```yaml
+- name: "屏蔽Yutube追踪"
+  filter:
+    url-regex: '^https?:\/\/(www|s)\.youtube\.com\/(pagead|ptracking)'
+  action: reject
+```
+
+同时一条合格的规则需要符合以下要求:
+
+- 专注:一条规则只用来做一件事
+- 简单:使用简单的方法来处理,便与维护
+- 高效:尽量使用高效的方法,比如使用域名后缀和域名前缀来替换域名正则表达式