Skip to content

Commit 2c0a8f5

Browse files
committed
README: use common capitalization style for "nginx" as a software
1 parent 77f3e2b commit 2c0a8f5

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77

88

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.
1010

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.
1212

1313
Notice that this project depends on libmodsecurity rather than ModSecurity (version 2.9 or less).
1414

@@ -25,7 +25,7 @@ Apache. As a result, This current version has less dependencies, fewer bugs, and
2525
Before compile this software make sure that you have libmodsecurity installed.
2626
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.
2727

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:
2929

3030
```
3131
./configure --add-module=/path/your/modsecurity-for-nginx
@@ -36,17 +36,17 @@ http://wiki.nginx.org/3rdPartyModules
3636

3737
# Usage
3838

39-
ModSecurity for Nginx extends your Nginx configuration directives. It adds four
39+
ModSecurity for nginx extends your nginx configuration directives. It adds four
4040
new directives and they are:
4141

4242
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.
4444

4545
modsecurity_rules_file [<path to rules file>] - This directive indicates the location of the modsecurity configuration file.
4646

4747
modsecurity_rules_remote [server-key] [<url to rules>] - 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.
4848

49-
modsecurity_rules [<modsecurity rule>] - This directive allows for the direct inclusion of a ModSecurity rule into the Nginx configuration.
49+
modsecurity_rules [<modsecurity rule>] - This directive allows for the direct inclusion of a ModSecurity rule into the nginx configuration.
5050

5151

5252
### 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
128128
### Testing your patch
129129

130130
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.
132132

133133
The nginx tests are available on: http://hg.nginx.org/nginx-tests/
134134

@@ -141,14 +141,14 @@ $ cd /path/to/nginx/test/repository
141141
$ TEST_NGINX_BINARY=/path/to/your/nginx prove .
142142
```
143143

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
145145

146146
### Debugging
147147

148148
We respect the nginx debugging schema. By using the configuration option
149149
“--with-debug” during the nginx configuration you will also be enabling the
150150
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,
152152
please check the nginx debugging information: http://wiki.nginx.org/Debugging
153153

154154

0 commit comments

Comments
 (0)