Skip to content

Commit d26800c

Browse files
committed
updated readme
1 parent 8c8d2d4 commit d26800c

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://zenhub.com)
66

77

8-
The ModSecurity-nginx connector is the connection point between nginx and libmodsecurity (ModSecurity v3). Said another way, this project provides a communication channel between nginx and libmodsecurity. This connector is required to use LibModSecurity with nginx.
8+
The ModSecurity-nginx connector is the connection point between nginx and libmodsecurity (ModSecurity v3). Said another way, this project provides a communication channel between nginx and libmodsecurity. This connector is required to use LibModSecurity with nginx.
99

1010
The ModSecurity-nginx connector takes the form of an nginx module. The module simply serves as a layer of communication between nginx and ModSecurity.
1111

@@ -176,6 +176,17 @@ using the same unique identificator.
176176

177177
String can contain variables.
178178

179+
modsecurity_proxy_protocol_ip
180+
-----------
181+
**syntax:** *modsecurity_proxy_protocol_ip on | off*
182+
183+
**context:** *http, server, location*
184+
185+
**default:** *off*
186+
187+
If activated, ModSecurity logs the actual IP address of a client when the connections is proxied using the Proxy Protocol.
188+
If a connection is proxied without this directive activated, the logged IP address is the one of the proxy server.
189+
179190

180191
# Contributing
181192

@@ -194,7 +205,7 @@ here: https://help.github.com/articles/using-pull-requests/
194205
Please respect the coding style in use. Pull requests can include various commits, so
195206
provide one fix or one functionality per commit. Do not change anything outside
196207
the scope of your target work (e.g. coding style in a function that you have
197-
passed by).
208+
passed by).
198209

199210
### Don’t know where to start?
200211

@@ -211,9 +222,9 @@ You may also take a look at recent bug reports and open issues to get an idea of
211222
### Testing your patch
212223

213224
Along with the manual testing, we strongly recommend that you to use the nginx test
214-
utility to make sure that you patch does not adversely affect the behavior or performance of nginx.
225+
utility to make sure that you patch does not adversely affect the behavior or performance of nginx.
215226

216-
The nginx tests are available on: http://hg.nginx.org/nginx-tests/
227+
The nginx tests are available on: http://hg.nginx.org/nginx-tests/
217228

218229
To use those tests, make sure you have the Perl utility prove (part of Perl 5)
219230
and proceed with the following commands:
@@ -226,7 +237,7 @@ $ TEST_NGINX_BINARY=/path/to/your/nginx prove .
226237

227238
If you are facing problems getting your added functionality to pass all the nginx tests, feel free to contact us or the nginx mailing list at: http://nginx.org/en/support.html
228239

229-
### Debugging
240+
### Debugging
230241

231242
We respect the nginx debugging schema. By using the configuration option
232243
"--with-debug" during the nginx configuration you will also be enabling the

0 commit comments

Comments
 (0)