You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
7
7
8
8
9
-
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.
9
+
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.
10
10
11
-
The ModSecurity-nginx connector takes the form of an Nginx module. The module simply serves as a layer of communication between Nginx and ModSecurity.
11
+
The ModSecurity-nginx connector takes the form of an nginx module. The module simply serves as a layer of communication between nginx and ModSecurity.
12
12
13
13
Notice that this project depends on libmodsecurity rather than ModSecurity (version 2.9 or less).
14
14
@@ -25,7 +25,7 @@ Apache. As a result, This current version has less dependencies, fewer bugs, and
25
25
Before compile this software make sure that you have libmodsecurity installed.
26
26
You can download it from the [ModSecurity git repository](https://github.com/SpiderLabs/ModSecurity). For information pertaining to the compilation and installation of libmodsecurity please consult the documentation provided along with it.
27
27
28
-
With libmodsecurity installed, you can proceed with the installation of the ModSecurity-nginx connector, which follow the Nginx 3rd party module installation procedure:
28
+
With libmodsecurity installed, you can proceed with the installation of the ModSecurity-nginx connector, which follow the nginx 3rd party module installation procedure:
ModSecurity for Nginx extends your Nginx configuration directives. It adds four
39
+
ModSecurity for nginx extends your nginx configuration directives. It adds four
40
40
new directives and they are:
41
41
42
42
modsecurity [On|Off] - This directive turns on or off ModSecurity functionality. Note that
43
-
this configuration directive is no longer related to the SecRule state. Instead, it now serves solely as an Nginx flag to enable or disable the module.
43
+
this configuration directive is no longer related to the SecRule state. Instead, it now serves solely as an nginx flag to enable or disable the module.
44
44
45
45
modsecurity_rules_file [<pathtorulesfile>] - This directive indicates the location of the modsecurity configuration file.
46
46
47
47
modsecurity_rules_remote [server-key][<urltorules>] - This directive is used to indicate from where (on the internet) a modsecurity configuration file will be downloaded. It also specifies the key that will be used to authenticate to that server.
48
48
49
-
modsecurity_rules [<modsecurityrule>] - This directive allows for the direct inclusion of a ModSecurity rule into the Nginx configuration.
49
+
modsecurity_rules [<modsecurityrule>] - This directive allows for the direct inclusion of a ModSecurity rule into the nginx configuration.
50
50
51
51
52
52
### Usage example: injecting rules within nginx configuration
@@ -128,7 +128,7 @@ You may also take a look at recent bug reports and open issues to get an idea of
128
128
### Testing your patch
129
129
130
130
Along with the manual testing, we strongly recommend that you to use the nginx test
131
-
utility to make sure that you patch does not adversely affect the behavior or performance of Nginx.
131
+
utility to make sure that you patch does not adversely affect the behavior or performance of nginx.
132
132
133
133
The nginx tests are available on: http://hg.nginx.org/nginx-tests/
134
134
@@ -141,14 +141,14 @@ $ cd /path/to/nginx/test/repository
141
141
$ TEST_NGINX_BINARY=/path/to/your/nginx prove .
142
142
```
143
143
144
-
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
144
+
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
145
145
146
146
### Debugging
147
147
148
148
We respect the nginx debugging schema. By using the configuration option
149
149
“--with-debug” during the nginx configuration you will also be enabling the
150
150
connector's debug messages. Core dumps and crashes are expected to be debugged
151
-
in the same fashion that is used to debug Nginx. For further information,
151
+
in the same fashion that is used to debug nginx. For further information,
152
152
please check the nginx debugging information: http://wiki.nginx.org/Debugging
0 commit comments