From 09b4ed5bb7bd3be95afa63358a30eeb80c12b60d Mon Sep 17 00:00:00 2001 From: "delong.wang" Date: Thu, 10 Aug 2023 12:44:13 +0800 Subject: [PATCH] feat(docs): update docs --- website/docs/01-introduction.md | 2 + website/docs/02-上手指南/01-guide_install.md | 11 +++-- website/docs/02-上手指南/03-guide_config.md | 8 ++-- website/docs/02-上手指南/04-guide_test.md | 6 +-- website/docs/02-上手指南/05-guide_upgrade.md | 30 +++++++------ .../docs/03-常见问题排查/01-faq_install.md | 7 ++- website/docs/03-常见问题排查/04-faq_config.md | 2 +- website/docs/03-常见问题排查/05-faq_other.md | 6 +-- .../docs/04-关于雷池/02-about_challenge.md | 9 ++-- .../docs/04-关于雷池/03-about_changelog.md | 45 +++++++++++++++++-- website/docs/04-关于雷池/04-about_chaitin.md | 9 ++-- website/src/css/custom.css | 7 ++- 12 files changed, 97 insertions(+), 45 deletions(-) diff --git a/website/docs/01-introduction.md b/website/docs/01-introduction.md index 50438f5..ba99b6a 100644 --- a/website/docs/01-introduction.md +++ b/website/docs/01-introduction.md @@ -2,6 +2,7 @@ title: "雷池简介" slug: / --- + # 雷池简介 ## 什么是 WAF @@ -35,6 +36,7 @@ Slogan：不让黑客越雷池半步。 并发能力强，单核轻松检测 2000+ TPS，只要硬件足够强，可支撑的流量规模无上限 #### 高可用 + 流量处理引擎基于 Nginx 开发，性能与稳定性均可得到保障 内置完善的健康检查机制，服务可用性高达 99.99% diff --git a/website/docs/02-上手指南/01-guide_install.md b/website/docs/02-上手指南/01-guide_install.md index b34792c..0c63f2f 100644 --- a/website/docs/02-上手指南/01-guide_install.md +++ b/website/docs/02-上手指南/01-guide_install.md @@ -32,7 +32,7 @@ df -h # 查看磁盘信息 ## 在线安装 -***如果服务器可以访问互联网环境，推荐使用该方式*** +**_如果服务器可以访问互联网环境，推荐使用该方式_** 执行以下命令，即可开始安装 @@ -42,16 +42,15 @@ bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)" > 如果连接 Docker Hub 网络不稳，导致镜像下载失败，可以采用 [离线安装](#离线安装) 方式 - 经过以上步骤，你的雷池已经安装好了，下一步请参考 [登录雷池](/docs/上手指南/guide_login) -## 离线安装 +## 离线安装 如果你的服务器无法连接互联网环境，或连接 Docker Hub 网络不稳，可以使用镜像包安装方式 > 这里忽略 Docker 安装的过程 -首先，下载 [雷池社区版镜像包](http://demo.waf-ce.chaitin.cn/image.tar.gz) 并传输到需要安装雷池的服务器上，执行以下命令加载镜像 +首先，下载 [雷池社区版镜像包](https://demo.waf-ce.chaitin.cn/image.tar.gz) 并传输到需要安装雷池的服务器上，执行以下命令加载镜像 ``` cat image.tar.gz | gzip -d | docker load @@ -64,7 +63,7 @@ mkdir -p safeline # 创建 safeline 目录 cd safeline # 进入 safeline 目录 ``` -下载 [编排脚本](https://waf-ce.chaitin.cn/release/latest/compose.yaml) 并传输到 safeline 目录中 +下载 [编排脚本](https://waf-ce.chaitin.cn/release/latest/compose.yaml) 并传输到 safeline 目录中 执行以下命令，生成雷池运行所需的相关环境变量 @@ -91,7 +90,7 @@ docker compose up -d ![](/images/docs/guide_install/collie_apps.png) -参考视频教程 [用 “白嫖的云主机” 一键安装 “开源的Web防火墙”](https://www.bilibili.com/video/BV1sh4y1t7Pk/) +参考视频教程 [用 “白嫖的云主机” 一键安装 “开源的 Web 防火墙”](https://www.bilibili.com/video/BV1sh4y1t7Pk/) ## 常见安装问题 diff --git a/website/docs/02-上手指南/03-guide_config.md b/website/docs/02-上手指南/03-guide_config.md index 2710a0c..1df119e 100644 --- a/website/docs/02-上手指南/03-guide_config.md +++ b/website/docs/02-上手指南/03-guide_config.md @@ -4,7 +4,6 @@ title: "配置防护站点" # 配置防护站点 - ![config_site.gif](https://waf-ce.chaitin.cn/images/gif/config_site.gif) 💡 TIPS: 添加后，执行 `curl -H "Host: <域名>" http://:<端口>` 应能获取到业务网站的响应。 @@ -12,11 +11,12 @@ title: "配置防护站点" ## 将网站流量切到雷池 - 若网站通过域名访问，则可将域名的 DNS 解析指向雷池所在设备 -![DNS.png](/images/docs/DNS.png) + ![DNS.png](/images/docs/DNS.png) - 若网站前有 nginx 、负载均衡等代理设备，则可将雷池部署在代理设备和业务服务器之间，然后将代理设备的 upstream 指向雷池 -![DNS.png](/images/docs/LoadBlance.png) + ![DNS.png](/images/docs/LoadBlance.png) + +## 如何配置 https -## 如何配置https ![safeline_https_website.gif](/images/docs/safeline_https_website.gif) ## 测试防护效果 diff --git a/website/docs/02-上手指南/04-guide_test.md b/website/docs/02-上手指南/04-guide_test.md index 0d6d95d..a3bd774 100644 --- a/website/docs/02-上手指南/04-guide_test.md +++ b/website/docs/02-上手指南/04-guide_test.md @@ -10,9 +10,9 @@ title: "测试防护效果" 打开浏览器访问 `http://:<端口>/` -> 网站协议默认是 http，勾选 ssl 则为 https +> 网站协议默认是 http，勾选 ssl 则为 https > 主机名可以是雷池的 IP，也可以是网站的域名（确保域名已经解析到雷池） -> 端口是你在雷池页面中配置的网站端口 +> 端口是你在雷池页面中配置的网站端口 若网站访问不正常，请参考 [网站无法访问](/docs/03-常见问题排查/03-faq_access.md) @@ -62,7 +62,7 @@ title: "测试防护效果" # 测试请求 ./blazehttp -t http://192.168.0.1:8080 -g './testcases/**/*.http' -sending 100% |██████████████████████████████████████████| (18/18, 86 it/s) +sending 100% |██████████████████████████████████████████| (18/18, 86 it/s) Total http file: 18, success: 18 failed: 0 Stat http response code diff --git a/website/docs/02-上手指南/05-guide_upgrade.md b/website/docs/02-上手指南/05-guide_upgrade.md index 0373a94..3b6d259 100644 --- a/website/docs/02-上手指南/05-guide_upgrade.md +++ b/website/docs/02-上手指南/05-guide_upgrade.md @@ -24,26 +24,30 @@ docker rmi $(docker images | grep "safeline" | grep "none" | awk '{print $3}') ## 离线镜像 -适用于 docker hub 拉取镜像失败的场景，手动更新镜像，注意还是要执行 `upgrade.sh` 来处理 `.env` 的更新，否则有可能会因为缺少参数而启动失败。 +适用于 docker hub 拉取镜像失败的场景，手动更新镜像。 +``` +# cd /path/to/safeline -下载 [雷池社区版镜像包](http://demo.waf-ce.chaitin.cn/image.tar.gz) 并传输到需要安装雷池的服务器上，执行以下命令加载镜像 +mv compose.yaml compose.yaml.old +wget "https://waf-ce.chaitin.cn/release/latest/compose.yaml" --no-check-certificate -O compose.yaml + +sed -i "s/IMAGE_TAG=.*/IMAGE_TAG=latest/g" ".env" + +grep "SAFELINE_DIR" ".env" > /dev/null || echo "SAFELINE_DIR=$(pwd)" >> ".env" +grep "IMAGE_TAG" ".env" > /dev/null || echo "IMAGE_TAG=latest" >> ".env" +grep "MGT_PORT" ".env" > /dev/null || echo "MGT_PORT=9443" >> ".env" +grep "POSTGRES_PASSWORD" ".env" > /dev/null || echo "POSTGRES_PASSWORD=$(LC_ALL=C tr -dc A-Za-z0-9 > ".env" +grep "REDIS_PASSWORD" ".env" > /dev/null || echo "REDIS_PASSWORD=$(LC_ALL=C tr -dc A-Za-z0-9 > ".env" +grep "SUBNET_PREFIX" ".env" > /dev/null || echo "SUBNET_PREFIX=172.22.222" >> ".env" +``` + +下载 [雷池社区版镜像包](https://demo.waf-ce.chaitin.cn/image.tar.gz) 并传输到需要安装雷池的服务器上，执行以下命令加载镜像 ``` docker load -i image.tar.gz ``` -**重要**, 进入安装雷池的目录 - -执行以下命令修改配置文件 - -``` -sed -i "s/IMAGE_TAG=.*/IMAGE_TAG=latest/g" ".env" -grep "SAFELINE_DIR" ".env" > /dev/null || echo "SAFELINE_DIR=$(pwd)" >> ".env" -grep "SUBNET_PREFIX" ".env" > /dev/null || echo "SUBNET_PREFIX=172.22.222" >> ".env" -grep "REDIS_PASSWORD" ".env" > /dev/null || echo "REDIS_PASSWORD=$(LC_ALL=C tr -dc A-Za-z0-9 > ".env" -``` - 执行以下命令替换 Docker 容器 ``` diff --git a/website/docs/03-常见问题排查/01-faq_install.md b/website/docs/03-常见问题排查/01-faq_install.md index 4ddd2b4..56045c0 100644 --- a/website/docs/03-常见问题排查/01-faq_install.md +++ b/website/docs/03-常见问题排查/01-faq_install.md @@ -1,12 +1,15 @@ --- title: "安装问题" --- + # 安装问题 -## 支不支持Mac or Windows -不支持，由于雷池所依赖的部分docker特性在Mac or Windows上并不生效，所以雷池在Mac or windows并不能正常工作 +## 支不支持 Mac or Windows + +不支持，由于雷池所依赖的部分 docker 特性在 Mac or Windows 上并不生效，所以雷池在 Mac or windows 并不能正常工作 ## 我能把雷池和业务服务部署到同一台机器中吗？ + 不建议，如放在一起，在流量不变的情况下，机器负载将高于分开部署,增大了资源耗尽的可能性 ## docker compose 还是 docker-compose？ diff --git a/website/docs/03-常见问题排查/04-faq_config.md b/website/docs/03-常见问题排查/04-faq_config.md index 3cdf34d..84394c9 100644 --- a/website/docs/03-常见问题排查/04-faq_config.md +++ b/website/docs/03-常见问题排查/04-faq_config.md @@ -42,7 +42,7 @@ title: "配置问题" 也可以直接通过 `docker logs -f safeline-tengine` 确认 SafeLine 是否有 nginx 报错说端口冲突。 -*常见的情况就是自己原先有一个服务监听在 `:80`，SafeLine 上配置了站点也监听 `:80` 端口，就产生了冲突。* +_常见的情况就是自己原先有一个服务监听在 `:80`，SafeLine 上配置了站点也监听 `:80` 端口，就产生了冲突。_ 如果没有的话，继续往下排查。 diff --git a/website/docs/03-常见问题排查/05-faq_other.md b/website/docs/03-常见问题排查/05-faq_other.md index b19879b..bb4ac5e 100644 --- a/website/docs/03-常见问题排查/05-faq_other.md +++ b/website/docs/03-常见问题排查/05-faq_other.md @@ -137,11 +137,9 @@ USER fluent 最后，编译完成后，我们将容器跑起来，参考命令 -```sh +``` echo "" > ./sql-state -docker run -d --restart=always --name safeline-fluentd \ - --net safeline-ce -v ./sql-state:/var/run/fluentd/sql_state \ - safeline-flunetd:latest +docker run -d --restart=always --name safeline-fluentd --net safeline-ce -v ./sql-state:/var/run/fluentd/sql_state safeline-flunetd:latest ``` 参考文档 diff --git a/website/docs/04-关于雷池/02-about_challenge.md b/website/docs/04-关于雷池/02-about_challenge.md index 1bdb8d8..13712fb 100644 --- a/website/docs/04-关于雷池/02-about_challenge.md +++ b/website/docs/04-关于雷池/02-about_challenge.md @@ -4,23 +4,26 @@ title: "人机验证" # 人机验证 -自从雷池社区版发布以来，我们一直密切关注用户对于爬虫和扫描器的反馈和防护需求。 因此，在2.0版本中，我们致力于探索与此相关的功能，以满足用户的期望和保护网站的安全。 +自从雷池社区版发布以来，我们一直密切关注用户对于爬虫和扫描器的反馈和防护需求。 因此，在 2.0 版本中，我们致力于探索与此相关的功能，以满足用户的期望和保护网站的安全。 ![challenge.png](/images/docs/challenge.png) ### 加入人机验证之后的请求处理流程 + ![flow.png](/images/docs/flow.png) - ### 人机验证如何配置 + 首先，点击位于左边栏的人机验证。之后，点击 **添加人机验证** ![add_challenge.png](/images/docs/add_challenge.png) 在这里我们可以配置是否开启交互式校验以及规则的名称以及规则的触发条件。 ### 人机验证触发规则 + 1. 规则内的条件之间是并且的关系，即需要全部命中，才会触发 2. 规则与规则之间是或的关系，则有一个命中，便会触发 ### 交互与非交互的区别 + 如果选择开启交互，那么用户需要点击页面中间的勾选框开始验证，如果选择非交互，那么将自动开始验证 -![manual.png](/images/docs/manual.png) \ No newline at end of file +![manual.png](/images/docs/manual.png) diff --git a/website/docs/04-关于雷池/03-about_changelog.md b/website/docs/04-关于雷池/03-about_changelog.md index 4cd5338..a2870d1 100644 --- a/website/docs/04-关于雷池/03-about_changelog.md +++ b/website/docs/04-关于雷池/03-about_changelog.md @@ -4,11 +4,36 @@ title: "版本更新记录" # 版本更新记录 -[版本升级方法](https://waf-ce.chaitin.cn/docs/02-上手指南/05-guide_upgrade) +[版本升级方法](/docs/上手指南/guide_upgrade) + +## [2.5.0] - 2023-08-03 + +#### 新增 + +- 请求频率限制（[#29](https://github.com/chaitin/safeline/issues/29)） + +#### 优化 + +- 支持筛选攻击检测日志的 ID（[#74](https://github.com/chaitin/safeline/issues/74)），优化筛选的交互 +- 证书支持 .cer 格式（[#181](https://github.com/chaitin/safeline/issues/181)） +- 优化人机校验页面，适配移动端（[#184](https://github.com/chaitin/safeline/issues/184)） +- 界面增加一些配置提示：添加站点时 “域名” 的格式、黑白名单/人机验证中匹配条件的生效逻辑 + +## [2.4.0] - 2023-07-27 + +#### 新增 + +- IP 组支持注释 [#143](https://github.com/chaitin/safeline/issues/143) + +#### 优化 + +- 优化编辑 IP 组和相关规则时的性能 +- 优化一些界面 UI 交互细节 ## [2.3.2] - 2023-07-24 #### 修复 + - 修复了攻击事件 - 原始日志中，请求报文没有格式化的问题 - 优化了一些已知问题 @@ -49,8 +74,8 @@ title: "版本更新记录" #### 新增 +- 支持自定义站点的 nginx conf，详情可见[官网文档](/docs/常见问题排查/faq_other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf) - 添加/编辑站点时，自动检查端口占用情况，避免保存后配置不生效 -- 支持自定义站点的 nginx conf，详情可见[官网文档](https://waf-ce.chaitin.cn/docs/常见问题排查/faq_other#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9-nginx-conf) - [站点列表支持按域名、端口或访问量进行排序](https://github.com/chaitin/safeline/issues/14) - [绑定 TOTP 密钥时，支持直接复制密钥；登录时的 6 位动态密码输入框，支持粘贴](https://github.com/chaitin/safeline/issues/30) @@ -78,6 +103,7 @@ title: "版本更新记录" - 把日志详情中的源 IP 加入到 IP 组时，支持调整 IP 为任意 IP 或网段 #### 优化 + - 日志列表按照时间和 ID 排序，防止出现小范围的时间乱序 - 转发流量时，自动设置请求头 X-Forwarded-Proto，适配更多代理场景 - 优化界面 UI，修复其他一些已知问题 @@ -105,7 +131,7 @@ title: "版本更新记录" #### 优化 - 检测日志的路由进一步完善 -- 数据统计页面更加紧凑，现在可以在 1920*1080 的屏幕上完全显示了 +- 数据统计页面更加紧凑，现在可以在 1920\*1080 的屏幕上完全显示了 - 黑白名单的展示优化 - 修复 通用配置-防护模块配置 中，“批量配置为” 按钮有时候不生效的问题 - 修复一些已知问题 @@ -137,23 +163,27 @@ title: "版本更新记录" ## [1.7.1] - 2023-06-05 #### 修复 + - 部分情况下无法打开日志详情页面的问题 - 部分情况下页面查询数量只有 10 条的问题 ## [1.7.0] - 2023-06-01 #### 新增 + - 新增 “IP 组” 功能，可以快速配置大量 IP 的黑/白名单了 - 防护策略增加 “仅观察” 配置 - 防护策略增加 “批量配置为” 按钮，可以快速切换所有模块的防护策略 #### 优化 + - 自定义规则列表增加翻页 - 优化规则生效顺序，现在会优先执行完所有白名单，再执行黑名单 ## [1.6.0] - 2023-05-25 #### 新增 + - 自定义规则支持匹配 Header 和 Body - 检测日志支持按域名搜索 - 支持命令行清理检测日志和统计信息 @@ -165,11 +195,13 @@ title: "版本更新记录" ## [1.5.0] - 2023-05-18 #### 新增 + - 支持 i18n - 数据统计新增 “今日请求错误情况” - 检测日志的筛选条件现在会显示在 URL，方便保存 #### 优化 + - 修复自定义规则的编辑表单，有时候会丢失编辑中数据的问题 - 修复 Safari 浏览器上的一些显示问题 - 修复 Payload 中存在非 Unicode 编码时，检测日志会入库失败的问题（不影响拦截） @@ -178,25 +210,30 @@ title: "版本更新记录" ## [1.4.0] - 2023-05-12 #### 新增 + - 自定义规则支持匹配域名 - 支持在一条自定义规则内，设置多个匹配条件 - 站点列表新增 “今日访问 / 拦截量” #### 优化 + - 优化交互和提示文案、修复已知问题 ## [1.3.0] - 2023-05-05 #### 新增 + - 支持按照源 IP、攻击类型、URL 筛选检测日志 #### 修复 + - 修复 dashboard 在部分低版本浏览器下的兼容问题 - 修复按源 IP 添加自定义规则时，添加不了 /8 和更大的网段的问题 ## [1.2.0] - 2023-04-27 #### 新增 + - 新增了数据统计页面，可以直观的看到流量大小 - 支持配置源 IP 提取方式，解决了源 IP 获取不对的问题 - 支持自定义检测策略，可以动态调整检测引擎 @@ -204,10 +241,12 @@ title: "版本更新记录" ## [1.1.0] - 2023-04-20 #### 新增 + - 支持根据 IP 和 URL 特征配置黑白名单 - 默认开启高防模式 #### 优化 + - 支持在日志详情中展示响应报文 - 服务器时间不准导致 TOTP 无法登录时增加了提示语 - 修复了上游服务器填 HTTPS 时端口解析不正确的问题 diff --git a/website/docs/04-关于雷池/04-about_chaitin.md b/website/docs/04-关于雷池/04-about_chaitin.md index 3cc1bd3..d955f9e 100644 --- a/website/docs/04-关于雷池/04-about_chaitin.md +++ b/website/docs/04-关于雷池/04-about_chaitin.md @@ -8,18 +8,17 @@ title: "关于我们" 雷池是长亭科技耗时近 10 年倾情打造的 Web 应用防护产品，核心检测能力由智能语义分析算法驱动。 -北京长亭未来科技有限公司是国际顶尖的网络信息安全公司之一，创始人团队 5 人均为清华博士，并引入阿里云安全核心人才团队。全球首发基于智能语义分析的下一代 Web 应用防火墙产品，目前，公司已形成以攻（安全评估系统）、防（下一代Web应用防火墙）、知（安全分析与管理平台）、查（主机安全管理平台）、抓（伪装欺骗系统）为核心的新一代安全防护体系，并提供优质的安全测试及咨询服务，为企业级客户带来智能的全新安全防护思路。 +北京长亭未来科技有限公司是国际顶尖的网络信息安全公司之一，创始人团队 5 人均为清华博士，并引入阿里云安全核心人才团队。全球首发基于智能语义分析的下一代 Web 应用防火墙产品，目前，公司已形成以攻（安全评估系统）、防（下一代 Web 应用防火墙）、知（安全分析与管理平台）、查（主机安全管理平台）、抓（伪装欺骗系统）为核心的新一代安全防护体系，并提供优质的安全测试及咨询服务，为企业级客户带来智能的全新安全防护思路。 长亭专注为企业级用户提供专业的网络信息安全解决方案。2016 年即发布基于人工智能语义分析的下一代 Web 应用防火墙，颠覆了传统依赖规则防护的工作原理，为企业用户带来智能、简单、省心的安全产品及服务。 长亭雷池坚持以技术为导向，产品与服务所涉及到的算法与核心技术均领先国际行业前沿标准，不仅颠覆了繁琐耗时的传统工作原理，更将产品性能提升至领先水准，为企业用户带来更快、更精准、更智能的安全防护。 - ## 荣誉 & 资质 ### 2021 年 -- 入选 IDC《中国硬件Web应用防火墙（WAF）市场份额》前四 +- 入选 IDC《中国硬件 Web 应用防火墙（WAF）市场份额》前四 - 重磅发布《实战攻防-企业红蓝对抗实践指南》 - 荣获 2021 网信自主创新优秀产品 “补天奖” - 荣膺 CNNVD 2020 年度优秀技术支撑单位 @@ -31,7 +30,7 @@ title: "关于我们" ### 2020 年 - 2020 年金融科技产品创新突出贡献奖 -- 2020 年网络安全创新能力100强 +- 2020 年网络安全创新能力 100 强 - 入选数世咨询《蜜罐诱捕能力指南》 - 入选数说安全中国网络安全市场全景图 - Network Products Guide IT World Award @@ -60,7 +59,7 @@ title: "关于我们" - 2018 年度金融科技优秀产品创新奖 - “2018 年度金牌服务机构” 安全服务奖 -### 2017 年 +### 2017 年 - OWASP 认证雷池（SafeLine）下一代 Web 应用防火墙 - 通过国家测评中心/信息安全服务资质测评单位 diff --git a/website/src/css/custom.css b/website/src/css/custom.css index a5105e6..0d26d6c 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -21,7 +21,6 @@ a:hover { --ifm-footer-link-hover-color: #0fc6c2; --ifm-navbar-link-hover-color: #0fc6c2; --ifm-navbar-background-color: #0f1935; - --ifm-menu-color: white; --ifm-navbar-link-color: white; } @@ -37,3 +36,9 @@ aside.theme-doc-sidebar-container { .navbar__toggle.clean-btn svg { color: white; } + +@media (max-width: 996px) { + :root { + --ifm-menu-color: white; + } +}