Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroennijhof committed May 26, 2014
1 parent 004c795 commit 02374e6
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
Openufp
=======

# Openufp
Open URL Filtering Proxy is an URL Filtering Server for N2H2 or Websense compatible devices.
It supports multiple back ends like url blacklist file, squidguard and proxy servers like dansguardian.
This project has been known as n2h2p.


Install
=====

# Install
Just type "make" followed by "sudo make install".
Make sure you have libdb and libdb-dev installed, preferable version 5.1 or higher.


Usage
=====

# Usage
```
Usage: openufp [OPTIONS] <-n|-w> <BACKEND>

OPTIONS:
-l PORT on which port openufp will listen for incoming requests
-r URL when url is denied the client will be redirected to this url; n2h2 only
-r URL when url is denied the client will be redirected to this url
-c SECS cache expire time in seconds; default 3600; 0 disables caching
-C URL remove specified URL from cache
-d LEVEL debug level 1-3
Expand All @@ -36,13 +31,10 @@ BACKEND:
-f FILE use the blacklist file backend
FILE is a file which contains blacklisted urls
-g use the squidGuard backend
```



Note
====

# Note
The default location of the cache db is /var/cache/openufp/cache.db.
When squidguard backend is used be sure that this program has rw permissions
to the squidguard db files.

0 comments on commit 02374e6

Please sign in to comment.