github_mirrors/lua-resty-coraza
3
0
Fork 1
mirror of https://github.com/potats0/lua-resty-coraza.git synced 2025-06-28 17:41:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
potatso 2023-07-07 14:59:34 +08:00
parent 8675c3a4a7
commit 72a7024512
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -5,11 +5,32 @@
Lua implementation of the [libcoraza](https://github.com/corazawaf/libcoraza) for modsecurity Web Application Firewall. Lua implementation of the [libcoraza](https://github.com/corazawaf/libcoraza) for modsecurity Web Application Firewall.
## Installation ## dependence
```bash ### 1. libcoraza-nginx
luarocks install lua-resty-t1k 1. clone the repository
`git clone https://github.com/potats0/coraza.git`
2. Build the source && Installation
``` ```
cd coraza
./build.sh
./configure
make
sudo make install
```
`libcoraza.so` will be installed at `/usr/local/lib`
### 2. Coreruleset
coreruleset is an opensource waf rules.
1. clone the repository
`git clone https://github.com/coreruleset/coreruleset`
### 3. lua-resty-coraza
```bash
opm get potats0/lua-resty-coraza
```
## Synopsis ## Synopsis
@ -54,3 +75,5 @@ if you need more log for debug, please turn on the debug on nginx.
``` ```
error_log logs/error.log debug; error_log logs/error.log debug;
``` ```
the matched rules log will be logged at `ngx.ctx.coraza_msg` by `coraza.do_log()`