📝 Update docs.

ADD-SP · Jun 3, 2021 · 0021cf9 · 0021cf9
1 parent 155b524
commit 0021cf9
Show file tree

Hide file tree

Showing 15 changed files with 88 additions and 39 deletions.
diff --git a/CHANGES-ZH-CN.md b/CHANGES-ZH-CN.md
@@ -4,16 +4,32 @@
 
 ### 新增
 
-* XSS 攻击防御（Powered By [libinjection](https://github.com/libinjection/libinjection)）。
-
 ### 移除
 
+### 变动
+
+### 修复
+
+***
+
+## [5.4.0] - 2021-06-03 UTC+0800
+
+### **注意**
+
+**本次更新更换了 libinjection 的 clone 链接，新的链接为 [https://github.com/libinjection/libinjection.git](https://github.com/libinjection/libinjection.git)。**
+
+### 新增
+
+* XSS 攻击防御（Powered By [libinjection](https://github.com/libinjection/libinjection)）。
 
 ### 变动
 
+* 增加内置变量计算相关的调试日志。
 
 ### 修复
 
+* POST 检测失效。
+
 ***
 
 ## [5.3.2] - 2021-05-28 UTC+0800

diff --git a/CHANGES.md b/CHANGES.md
@@ -4,16 +4,32 @@
 
 ### Added
 
-* Anti XSS (powered by [libinjection](https://github.com/libinjection/libinjection)).
-
 ### Removed
 
+### Changed
+
+### Fixed
+
+
+***
+
+## [5.4.0] - 2021-06-03 UTC+0800
+
+### **NOTE**
+
+**The clone link for `libinjection` has been replaced in this release. The new link is [https://github.com/libinjection/libinjection.git](https://github.com/libinjection/libinjection.git).**
+
+### Added
+
+* Anti XSS (powered by [libinjection](https://github.com/libinjection/libinjection)).
 
 ### Changed
 
+* Add debug log related to built-in variable calculation.
 
 ### Fixed
 
+* POST inspection is not working.
 
 ***
 

diff --git a/README-ZH-CN.md b/README-ZH-CN.md
@@ -2,7 +2,7 @@
 
 
 <p align="center">
-    <img src="https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/logo.png" width=200 height=200/>
+    <img src="https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/assets/logo.png" width=200 height=200/>
 </p>
 
 

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # ngx_waf
 
 <p align="center">
-    <img src="https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/logo.png" width=200 height=200/>
+    <img src="https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/assets/logo.png" width=200 height=200/>
 </p>
 
 [![test](https://github.com/ADD-SP/ngx_waf/workflows/test/badge.svg)](https://github.com/ADD-SP/ngx_waf/actions?query=workflow%3Atest)

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 ---
 home: true
-heroImage: https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/logo.png
+heroImage: https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/assets/logo.png
 heroText: ngx_waf
 tagline: Handy, High performance Nginx firewall module.
 actionText: Quick Start →

diff --git a/docs/advance/changes.md b/docs/advance/changes.md
@@ -9,16 +9,32 @@ lang: en
 
 ### Added
 
-* Anti XSS (powered by [libinjection](https://github.com/libinjection/libinjection)).
-
 ### Removed
 
+### Changed
+
+### Fixed
+
+
+***
+
+## [5.4.0] - 2021-06-03 UTC+0800
+
+### **NOTE**
+
+**The clone link for `libinjection` has been replaced in this release. The new link is [https://github.com/libinjection/libinjection.git](https://github.com/libinjection/libinjection.git).**
+
+### Added
+
+* Anti XSS (powered by [libinjection](https://github.com/libinjection/libinjection)).
 
 ### Changed
 
+* Add debug log related to built-in variable calculation.
 
 ### Fixed
 
+* POST inspection is not working.
 
 ***
 
@@ -30,7 +46,6 @@ lang: en
 
 ***
 
-
 ## [5.3.1] - 2021-05-26 GMT+0800
 
 ### Fixed

diff --git a/docs/advance/issue.md b/docs/advance/issue.md
@@ -6,5 +6,4 @@ lang: en
 # Known Issues
 
 Bugs that exist in the latest stable release are listed here, 
-bugs that have been fixed in the latest stable release are not listed here.
-
+bugs that have been fixed in the latest stable release are not listed here.
diff --git a/docs/advance/variable.md b/docs/advance/variable.md
@@ -13,7 +13,7 @@ This module adds three available variables.
 
 Not an empty string if the firewall is checked in this request, otherwise an empty string. This variable is mainly used in the directive `access_log`, see [Customised Log Format](log.md#customised-log-format).
 
-## `waf_blocking_log`
+## `$waf_blocking_log`
 
 Not an empty string if this request was originally blocked by the module, and vice versa. This variable is mainly used in the directive `access_log`, see [Customised Log Format](log.md#customised-log-format).
 

diff --git a/docs/guide/overview.md b/docs/guide/overview.md
@@ -32,12 +32,6 @@ Handy, High performance Nginx firewall module.
 * Block the specified Referer.
 
 
-::: tip NOTE
-
-The feature `Anti XSSS` is currently only available in the development version.
-
-:::
-
 ## Contact
 
 * Telegram Channel: [https://t.me/ngx_waf](https://t.me/ngx_waf)

diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
@@ -1,6 +1,6 @@
 ---
 home: true
-heroImage: https://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/logo.png
+heroImage: hhttps://cdn.jsdelivr.net/gh/ADD-SP/ngx_waf@master/assets/logo.png
 heroText: ngx_waf
 tagline: 方便且高性能的 Nginx 防火墙模块。
 actionText: 快速上手 →

diff --git a/docs/zh-cn/advance/changes.md b/docs/zh-cn/advance/changes.md
@@ -9,16 +9,31 @@ lang: zh-CN
 
 ### 新增
 
-* XSS 攻击防御（Powered By [libinjection](https://github.com/libinjection/libinjection)）。
-
 ### 移除
 
+### 变动
+
+### 修复
+
+***
+
+## [5.4.0] - 2021-06-03 UTC+0800
+
+### **注意**
+
+**本次更新更换了 libinjection 的 clone 链接，新的链接为 [https://github.com/libinjection/libinjection.git](https://github.com/libinjection/libinjection.git)。**
+
+### 新增
+
+* XSS 攻击防御（Powered By [libinjection](https://github.com/libinjection/libinjection)）。
 
 ### 变动
 
+* 增加内置变量计算相关的调试日志。
 
 ### 修复
 
+* POST 检测失效。
 
 ***
 

diff --git a/docs/zh-cn/advance/issue.md b/docs/zh-cn/advance/issue.md
@@ -5,4 +5,4 @@ lang: zh-CN
 
 # 已知问题
 
-这里只会列出存在于最新的稳定版的问题，已经在最新的稳定版中修复的问题不会列出。
+这里只会列出存在于最新的稳定版的问题，已经在最新的稳定版中修复的问题不会列出。
diff --git a/docs/zh-cn/advance/priority.md b/docs/zh-cn/advance/priority.md
@@ -12,14 +12,15 @@ lang: zh-CN
 1. IP 白名单检测
 2. IP 黑名单检测
 3. CC 防御检测
-4. Url 白名单检测
-5. Url 黑名单检测
-6. Get 参数黑名单检测
-7. User-Agent 黑名单检测
-8. Referer 白名单检测
-9. Referer 黑名单检测
-10. Cookie 黑名单检测
-11. Post 请求体黑名单
+4. Under-Attack 模式
+5. Url 白名单检测
+6. Url 黑名单检测
+7. Get 参数黑名单检测
+8. User-Agent 黑名单检测
+9. Referer 白名单检测
+10. Referer 黑名单检测
+11. Cookie 黑名单检测
+12. Post 请求体黑名单
 
 
 ::: tip 修改优先级

diff --git a/docs/zh-cn/advance/variable.md b/docs/zh-cn/advance/variable.md
@@ -13,7 +13,7 @@ lang: zh-CN
 
 如果本次请求中防火墙进行了检查则不为空字符串，反之为空字符串。本变量主要用于 `access_log` 指令，详见 [自定义日志格式](log.md#自定义日志格式)。
 
-## `waf_blocking_log`
+## `$waf_blocking_log`
 
 如果本次请求本被模块拦截则不为空字符串，反之则为空字符串。本变量主要用于 `access_log` 指令，详见 [自定义日志格式](log.md#自定义日志格式)。
 

diff --git a/docs/zh-cn/guide/overview.md b/docs/zh-cn/guide/overview.md
@@ -28,13 +28,6 @@ lang: zh-CN
 * Cookie 黑名单。
 * Referer 黑白名单。
 
-
-::: tip 注意
-
-xss 攻击防护功能目前仅开发版可用。
-
-:::
-
 ## 联系方式
 
 * Telegram 频道: [https://t.me/ngx_waf](https://t.me/ngx_waf)