浏览代码

更新文档 (#807)

ct-jaryn 1 年之前
父节点
当前提交
75c9510aa5

+ 8 - 2
documents/docs/02-guide/05-test.md

@@ -61,13 +61,19 @@ title: "测试防护"
 3. 使用以下请求开始测试
 
 ```
-./blazehttp -t http://<IP或域名>:<端口>
+./选择对应版本 -t http://<IP或域名>:<端口>
+
+windows下
+./blazehttp_windows.exe -t http://<IP或域名>:<端口>
+
+linux下
+./blazehttp_linux_x64 -t http://<IP或域名>:<端口>
 ```
 
 ### 测试效果展示
 
 ```sh
-# 测试请求
+# linux测试请求演示
 ./blazehttp -t http://127.0.0.1:8008
 sending 100% |█████████████████████████████████████████████████████████| (33669/33669, 940 it/s) [35s:0s]
 总样本数量: 33669    成功: 33669    错误: 0

+ 5 - 7
documents/docs/03-faq/01-install.md

@@ -26,9 +26,8 @@ title: "安装问题"
 
 需要安装 docker。尝试 `curl -fLsS https://get.docker.com/ | sh` 或者 [Install Docker Engine](https://docs.docker.com/engine/install/)。
 
-#### 报错:docker not found, unable to deploy
+#### 报错:failed to create network safeline-ce
 
-failed to create network safeline-ce
 safeline-ce 是雷池部署时候创建的 network,出现类似报错,先重启下 dockerd 之后重试
 
 需要启动 docker daemon 才能执行相关的命令。尝试 `systemctl start docker`。
@@ -37,10 +36,6 @@ safeline-ce 是雷池部署时候创建的 network,出现类似报错,先重
 
 需要安装 `docker compose v2`。尝试 `[Install Docker Compose](https://docs.docker.com/compose/install/)`。
 
-#### 报错: `failed to create network safeline-ce`
-
-safeline-ce 是雷池部署时候创建的 network,出现类似报错,先重启下 dockerd 之后重试。
-
 #### 报错: safeline-tengine 出现 Address already in use
 
 `docker logs -f safeline-tengine` 容器日志中看到 `Address already in use` 信息。
@@ -103,8 +98,11 @@ security_opt:
 
 在安装目录(默认 safeline)下
 
-根据本地的compose版本,执行 `docker compose down` 或者 `docker-compose down`
+1.根据本地的compose版本,执行 `docker compose down` 或者 `docker-compose down` 停止容器
+
+2.手动删除镜像
 
+3.动手删除目录
 
 
 ## 问题无法解决

+ 7 - 1
documents/docs/03-faq/03-config.md

@@ -81,10 +81,16 @@ title: "配置问题"
 
 ## 配置完成后,测试时返回 400 Request Header Or Cookie Too Large
 
-请麻烦检查是否形成了环路,即:雷池将请求转发给上游服务器后,上游服务器又将请求转发回雷池。
+检查是否形成了环路,即:雷池将请求转发给上游服务器后,上游服务器又将请求转发回雷池。
+
+重新修改配置后再次测试
 
 ## 不同版本关闭防火墙的命令
    
+默认使用雷池不需要关闭防火墙,配置对应的开放规则即可 
+
+如果需要直接关闭防火墙可以参考
+
 Ubuntu 18.04 LTS 、 Ubuntu 20.04 LTS 、 Ubuntu 22.04 LTS
 
 Debian 9 (Stretch)、Debian 10 (Buster)、Debian 11 (Bullseye)

+ 16 - 0
documents/docs/03-faq/04-test.md

@@ -45,6 +45,22 @@ docker exec safeline-tengine nginx -s reload
 
 **_注意:该操作会加快对硬盘的消耗,请定时清理访问日志_**
 
+## 有信任的ip进入了社区黑名单怎么办 
+
+社区黑名单的进入条件是需要多个雷池设备上报恶意行为,自动移出条件是连续一段时间没有被上报
+
+由于网络环境的复杂性,存在ip被利用或者规则误报导致进入社区黑名单的情况
+
+出于安全考虑,雷池社区不会主动为任何人移出社区黑名单
+
+误报如何处理
+
+1.排查信任ip的情况,确认是否真的安全
+
+2.对信任的ip针对性配置加白规则
+
+3.等待信任ip自动被移出社区黑名单
+
 ## 问题无法解决
 
 1. 通过右上角搜索检索其他页面

+ 6 - 3
documents/docs/05-about/03-framework.md

@@ -4,7 +4,7 @@ title: "雷池技术架构"
 
 # 雷池技术架构
 
-查看雷池的服务架构图。最上面虚线框住的是数据流,也就是访问业务服务器的流量数据的流动情况。中间框起来的部分是雷池的各个服务。
+查看雷池的服务架构图(示意图较老,参考为主)。最上面虚线框住的是数据流,也就是访问业务服务器的流量数据的流动情况。中间框起来的部分是雷池的各个服务。
 
 ![framework](/images/docs/framework.png)
 
@@ -12,11 +12,14 @@ title: "雷池技术架构"
 
 | 名称              | 定义         | 详情                                                    |
 | ----------------- | ------------ | ------------------------------------------------------- |
-| safeline-mgt  | 管理容器     | 接收管理后台行为,向其他服务或容器推送消息              |
+| safeline-mgt  | 管理容器(管理端)     | 接收管理后台行为,向其他服务或容器推送消息              |
 | safeline-detector | 检测容器     | 执行检测的容器,从 Tengine 进入的流量会转发到该节点检测 |
 | safeline-mario    | 日志容器     | 记录与统计恶意行为的节点                                |
-| safeline-tengine  | 网关         | 转发网关,有简单的过滤功能                              |
+| safeline-tengine  | 网关         | 转发网关,有简单的过滤功能,基于nginx实现                              |
 | safeline-pg | 关系型数据库 | 存储攻击日志、保护站点、黑白名单配置的数据库            |
+| safeline-luigi | 数据统计服务 | 统计qps等信息            |
+| safeline-fvm | 规则处理容器 | 将规则传递到检测容器            |
+| safeline-bridge | 支持云托管 | 通讯的桥接器            |
 
 对于后台管理人员,可以直接通信的节点为管理服务 `safeline-mgt`,该节点负责: