Update and rename README to README.md

This commit is contained in:
Scott Wallace 2013-06-25 17:54:36 +02:00
parent 3e54c5ff97
commit 5f3dbc4e5a
2 changed files with 43 additions and 38 deletions

View file

@ -1,38 +0,0 @@
Compilation
-----------
1. Ensure the SQLite development libraries (sqlite-devel) are installed.
2. Either run the build_from_scratch.sh script or run the following commands:
1. libtoolize
2. aclocal
3. autoconf
4. automake -a
5. ./configure --with-apache=<Apache location>
6. make CFLAGS=-lsqlite3
Installation
------------
1. Activate in Apache using:
a) (automatic) Using APXS:
apxs -i -a -n blockinator libmodblockinator.la
b) (manual) Add the following commands to the Apache configuration:
LoadModule blockinator_module modules/libmodblockinator.so
2. Configure mod_blockinator by adding the following lines in the appropriate location(s):
1. Define where the blocklist DB can be found:
<IfModule blockinator_module>
BlockinatorBlocklistDB /path/to/blocklist.db
</IfModule>
2. Create a mod_rewrite rule to block requests, if matched:
RewriteCond %{HTTP:X-Block} 1
RewriteRule . - [R=403,L]
3. Create the SQLite DB:
1. sqlite3 /path/to/blocklist.db
2. Run the following SQL:
CREATE TABLE IF NOT EXISTS blocklist(remote_ip VARCHAR(15), forwarded_ip VARCHAR(15), useragent VARCHAR(256), cookie VARCHAR(1024), PRIMARY KEY(remote_ip));
3. (optional) Insert some test data:
Block requests from IP address 1.2.3.4
e.g. INSERT INTO blocklist VALUES("1.2.3.4", "ANY", "ANY", "ANY");
4. Restart Apache

43
apache/README.md Normal file
View file

@ -0,0 +1,43 @@
# Compilation
1. Ensure the SQLite development libraries (sqlite-devel) are installed.
2. Either run the `build_from_scratch.sh` script or run the following commands:
1. `libtoolize`
2. `aclocal`
3. `autoconf`
4. `automake -a`
5. `./configure --with-apache=<Apache location>`
6. `make CFLAGS=-lsqlite3`
# Installation
1. Activate in Apache using:
* (automatic) Using APXS:
```
apxs -i -a -n blockinator libmodblockinator.la
```
_*or*_
* (manual) Add the following commands to the Apache configuration:
```
LoadModule blockinator_module modules/libmodblockinator.so
```
2. Configure mod\_blockinator by adding the following lines in the appropriate location(s):
1. Define where the blocklist DB can be found:
```
<IfModule blockinator_module>
BlockinatorBlocklistDB /path/to/blocklist.db
</IfModule>
```
2. Create a mod\_rewrite rule to block requests, if matched:
```
RewriteCond %{HTTP:X-Block} 1
RewriteRule . - [R=403,L]
```
3. Create the SQLite DB:
1. `sqlite3 /path/to/blocklist.db`
2. Run the following SQL:
```
CREATE TABLE IF NOT EXISTS blocklist(remote_ip VARCHAR(15), forwarded_ip VARCHAR(15), useragent VARCHAR(256), cookie VARCHAR(1024), PRIMARY KEY(remote_ip));
```
3. (optional) Insert some test data:
Block requests from IP address 1.2.3.4
e.g. ```INSERT INTO blocklist VALUES("1.2.3.4", "ANY", "ANY", "ANY");```
4. Restart Apache