Skip to content

Commit 3c86d57

Browse files
committed
README: minor fixes
1 parent 8085a2f commit 3c86d57

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://zenhub.com)
66

77

8-
98
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.
109

1110
The ModSecurity-nginx connector takes the form of an nginx module. The module simply serves as a layer of communication between nginx and ModSecurity.
@@ -17,7 +16,7 @@ Notice that this project depends on libmodsecurity rather than ModSecurity (vers
1716
The old version uses ModSecurity standalone, which is a wrapper for
1817
Apache internals to link ModSecurity to nginx. This current version is closer
1918
to nginx, consuming the new libmodsecurity which is no longer dependent on
20-
Apache. As a result, This current version has less dependencies, fewer bugs, and is faster. In addition, Some new functionality is also provided - such as the possibility of use of global rules configuration with per directory/location customizations (e.g. SecRuleRemoveById).
19+
Apache. As a result, this current version has less dependencies, fewer bugs, and is faster. In addition, some new functionality is also provided - such as the possibility of use of global rules configuration with per directory/location customizations (e.g. SecRuleRemoveById).
2120

2221

2322
# Compilation
@@ -28,12 +27,13 @@ You can download it from the [ModSecurity git repository](https://github.com/Spi
2827
With libmodsecurity installed, you can proceed with the installation of the ModSecurity-nginx connector, which follow the nginx 3rd party module installation procedure:
2928

3029
```
31-
./configure --add-module=/path/your/modsecurity-for-nginx
30+
./configure --add-module=/path/to/ModSecurity-nginx
3231
```
3332

3433
Further information about nginx 3rd party add-ons support are available here:
3534
http://wiki.nginx.org/3rdPartyModules
3635

36+
3737
# Usage
3838

3939
ModSecurity for nginx extends your nginx configuration directives. It adds four
@@ -48,7 +48,6 @@ modsecurity_rules_remote [server-key] [<url to rules>] - This directive is used
4848

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

51-
5251
### Usage example: injecting rules within nginx configuration
5352
```
5453
...
@@ -95,12 +94,14 @@ location / {
9594
...
9695
```
9796

97+
9898
# Contributing
9999

100100
As an open source project we invite (and encourage) anyone from the community to contribute to our project. This may take the form of: new
101101
functionality, bug fixes, bug reports, beginners user support, and anything else that you
102102
are willing to help with. Thank you.
103103

104+
104105
## Providing Patches
105106

106107
We prefer to have your patch within the GitHub infrastructure to facilitate our
@@ -146,7 +147,7 @@ If you are facing problems getting your added functionality to pass all the ngin
146147
### Debugging
147148

148149
We respect the nginx debugging schema. By using the configuration option
149-
--with-debugduring the nginx configuration you will also be enabling the
150+
"--with-debug" during the nginx configuration you will also be enabling the
150151
connector's debug messages. Core dumps and crashes are expected to be debugged
151152
in the same fashion that is used to debug nginx. For further information,
152153
please check the nginx debugging information: http://wiki.nginx.org/Debugging
@@ -168,11 +169,13 @@ version of your libmodsecurity and the version of the nginx connector you are ru
168169
Please do not publicly report any security issue. Instead, contact us at:
169170
[email protected] to report the issue. Once the problem is fixed we will provide you with credit for the discovery.
170171

172+
171173
## Feature Request
172174

173175
We would love to discuss any ideas that you may have for a new feature. Please keep in mind this is a community driven project so be sure to contact the community via the mailing list to get feedback first. Alternatively,
174176
feel free to open GitHub issues requesting for new features. Before opening a new issue, please check if there is an existing feature request for the desired functionality.
175177

178+
176179
## Packing
177180

178181
Having our packages in distros on time is something we highly desire. Let us know if

0 commit comments

Comments
 (0)