update readme

This commit is contained in:
potatso 2023-07-07 14:59:34 +08:00
parent 8675c3a4a7
commit 72a7024512

View File

@ -5,11 +5,32 @@
Lua implementation of the [libcoraza](https://github.com/corazawaf/libcoraza) for modsecurity Web Application Firewall.
## Installation
## dependence
```bash
luarocks install lua-resty-t1k
### 1. libcoraza-nginx
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
@ -53,4 +74,6 @@ if you need more log for debug, please turn on the debug on nginx.
```
error_log logs/error.log debug;
```
```
the matched rules log will be logged at `ngx.ctx.coraza_msg` by `coraza.do_log()`