Skip to content
This repository was archived by the owner on May 14, 2020. It is now read-only.

Commit 462d2a1

Browse files
committed
INSTALL: advise to use release zips, remove upgrade.py, update Nginx
1 parent 726aa7e commit 462d2a1

File tree

1 file changed

+28
-34
lines changed

1 file changed

+28
-34
lines changed

INSTALL

Lines changed: 28 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,21 @@ Installing From a Package Manager
2929

3030
modsecurity-crs - Debian
3131
mod_security_crs - Fedora
32-
modsecurity-crs - Gentoo
32+
modsecurity-crs - Gentoo
3333

3434
Packages of CRS 2.x are incompatible with CRS 3.x.
3535

36-
Installing From Git
37-
===================
36+
Installing
37+
==========
3838

39-
Github is the preferred way to download and install CRS. Doing so
40-
insures that you have the most recent version of the rules. We
41-
encourage you to create scripts that will automatically download
42-
updates at regular intervals so that you may be protected against
43-
the latest threats that CRS adds protection for.
39+
You can download a copy of the CRS from the following URL:
40+
https://coreruleset.org/installation/
4441

45-
The script util/upgrade.py is an example for script. You can use
46-
it as follows:
42+
Our release zip/tar.gz files are the preferred way to install CRS.
4743

48-
```
49-
./util/upgrade.py --crs
50-
```
44+
However, if you want to follow rule development closely and get
45+
the newest protections quickly, you can also clone our GitHub
46+
repository to get the current work-in-progress for the next release.
5147

5248
Prerequisites
5349
-------------
@@ -85,20 +81,19 @@ Installing on Apache
8581
to create a new folder underneath the Apache directory (typically
8682
/usr/local/apache/, /etc/httpd/, or /etc/apache2). Often this folder
8783
is called 'modsecurity.d'. Create this folder and cd into it.
88-
4. Clone the repository into the modsecurity.d folder using:
89-
```git clone https://github.com/SpiderLabs/owasp-modsecurity-crs .```
90-
This will create a new owasp-modsecurity-crs folder.
84+
4. Download our release from https://coreruleset.org/installation/
85+
and unpack it into a new owasp-modsecurity-crs folder.
9186
5. Move the crs-setup.conf.example file to crs-setup.conf.
9287
Please take the time to go through this file and customize the settings
93-
for your local environment. Failure to do so may result in false
94-
negatives and false positives. See the section entitled OWASP CRS
88+
for your local environment. Failure to do so may result in false
89+
negatives and false positives. See the section entitled OWASP CRS
9590
Configuration for more detail.
9691
6. Rename rules/REQUEST-900-EXCLUSION-RULES-BEFORE-CRS.conf.example and
9792
rules/RESPONSE-999-EXCLUSION-RULES-AFTER-CRS.conf.example to remove the
9893
'.example' extension. This will allow you to add exclusions without updates
9994
overwriting them in the future.
100-
7. Add the following line to your httpd.conf/apache2.conf (the following
101-
assumes you've cloned CRS into modsecurity.d/owasp-modsecurity-crs). You
95+
7. Add the following line to your httpd.conf/apache2.conf (the following
96+
assumes you've put CRS into modsecurity.d/owasp-modsecurity-crs). You
10297
can alternatively place these in any config file included by Apache:
10398
```
10499
<IfModule security2_module>
@@ -121,8 +116,8 @@ Installing on Nginx
121116
to create a new folder underneath the Nginx directory (typically
122117
/usr/local/nginx/conf/). Often this folder
123118
is called 'owasp-modsecurity-crs'. Create this folder and cd into it.
124-
4. Clone the repository into the current folder using:
125-
```git clone https://github.com/SpiderLabs/owasp-modsecurity-crs .```
119+
4. Download our release from https://coreruleset.org/installation/
120+
and unpack it into a new owasp-modsecurity-crs folder.
126121
5. Move the crs-setup.conf.example file to crs-setup.conf.
127122
Please take this time to go through this
128123
file and customize the settings for your local environment. Failure to
@@ -147,6 +142,12 @@ Installing on Nginx
147142
include owasp-modsecurity-crs/crs-setup.conf
148143
include owasp-modsecurity-crs/rules/REQUEST-900-EXCLUSION-RULES-BEFORE-CRS.conf
149144
include owasp-modsecurity-crs/rules/REQUEST-901-INITIALIZATION.conf
145+
include owasp-modsecurity-crs/rules/REQUEST-903.9001-DRUPAL-EXCLUSION-RULES.conf
146+
include owasp-modsecurity-crs/rules/REQUEST-903.9002-WORDPRESS-EXCLUSION-RULES.conf
147+
include owasp-modsecurity-crs/rules/REQUEST-903.9003-NEXTCLOUD-EXCLUSION-RULES.conf
148+
include owasp-modsecurity-crs/rules/REQUEST-903.9004-DOKUWIKI-EXCLUSION-RULES.conf
149+
include owasp-modsecurity-crs/rules/REQUEST-903.9005-CPANEL-EXCLUSION-RULES.conf
150+
include owasp-modsecurity-crs/rules/REQUEST-903.9006-XENFORO-EXCLUSION-RULES.conf
150151
include owasp-modsecurity-crs/rules/REQUEST-905-COMMON-EXCEPTIONS.conf
151152
include owasp-modsecurity-crs/rules/REQUEST-910-IP-REPUTATION.conf
152153
include owasp-modsecurity-crs/rules/REQUEST-911-METHOD-ENFORCEMENT.conf
@@ -158,9 +159,11 @@ Installing on Nginx
158159
include owasp-modsecurity-crs/rules/REQUEST-931-APPLICATION-ATTACK-RFI.conf
159160
include owasp-modsecurity-crs/rules/REQUEST-932-APPLICATION-ATTACK-RCE.conf
160161
include owasp-modsecurity-crs/rules/REQUEST-933-APPLICATION-ATTACK-PHP.conf
162+
include owasp-modsecurity-crs/rules/REQUEST-934-APPLICATION-ATTACK-NODEJS.conf
161163
include owasp-modsecurity-crs/rules/REQUEST-941-APPLICATION-ATTACK-XSS.conf
162164
include owasp-modsecurity-crs/rules/REQUEST-942-APPLICATION-ATTACK-SQLI.conf
163165
include owasp-modsecurity-crs/rules/REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION.conf
166+
include owasp-modsecurity-crs/rules/REQUEST-933-APPLICATION-ATTACK-JAVA.conf
164167
include owasp-modsecurity-crs/rules/REQUEST-949-BLOCKING-EVALUATION.conf
165168
include owasp-modsecurity-crs/rules/RESPONSE-950-DATA-LEAKAGES.conf
166169
include owasp-modsecurity-crs/rules/RESPONSE-951-DATA-LEAKAGES-SQL.conf
@@ -181,8 +184,8 @@ Installing on IIS
181184
To upgrade or install this after the fact follow the following
182185
steps.
183186
1. Navigate to "[drive_letters]:\Program Files\ModSecurity IIS\"
184-
2. Clone the repository into the current folder using:
185-
```git clone https://github.com/SpiderLabs/owasp-modsecurity-crs```
187+
2. Download our release from https://coreruleset.org/installation/
188+
and unpack it into the current folder.
186189
3. Move the crs-setup.conf.example file to crs-setup.conf.
187190
Please take this time to go through this
188191
file and customize the settings for your local environment. Failure to
@@ -290,16 +293,7 @@ OWASP CRS Configuration
290293
Make sure your GeoIP and Project Honeypot settings are specified
291294
if you are using them.
292295
The GeoIP database is no longer included with the CRS. Instead
293-
you are advised to download it regularly. The script
294-
util/upgrade.py brings this functionality. You can use it as
295-
follows in cron:
296-
297-
```
298-
0 2 * * * util/upgrade.py --geoip --cron
299-
300-
```
301-
The use of the option --cron guarantees that the GeoIP
302-
download server is not hammered.
296+
you are advised to download it regularly.
303297

304298
The use of Project Honeypot requires a
305299
free API key. These require an account but can be obtained at

0 commit comments

Comments
 (0)