 SQUIDWALL README
==================



WHAT IS IT
----------

Squidwall is a fast, small, and secure squid redirector. It enables the
administrator to build an easy to use Webinterface for controlling
user-, host-, or IP-based access to squid.

It also does filtering of text and HTML pages containing obscene content with
an advanced phrase weighting system like dansguardian, pass-through antivirus
scanning with clamav and banner filtering.




FEATURES
--------

- summary:
  - user / host / ip based access control to squid
  - pass-through antivirus scanning with clamav
  - full url and content filtering with different methods:
    - case insensitive string comparing
    - regex.7 expressions
    - phrase weighting

- after changing the acl's or the filters, squid and squidwall doesn't need to
  be restarted, there is also no need for a kill -HUP or sth. like that!

- can filter text and HTML pages with obscene content, using an advanced phrase
  weighting system like dansguardian

- you can log information like the username, the source ip and a lot more in your
  'redirect to' site

- it has the ability to switch off filtering for specified sites, parts of
  sites, hosts, ip's, usernames ...

- the acl's are two directories, which have empty files named by these convention:
  '+filename' -> access ok
  '?filename' -> restricted access ok
  '-filename' -> access denied

- you can set special filtering options and / or filterlists for each acl



VARIABLES FOR REDIR-SITES
-------------------------

These variables can be used in the errorpages, the client/user will see:

$version - version of squidwall
$url     - the requested url
$ip      - the ip, which has sent the request
$host    - the hostname, which has sent the request
$user    - the user, which has sent the request
$method  - the request method

$clamd   - version of clamd (e.g. ClamAV 0.87.1/1198/Tue Nov 29 11:05:20 2005)
$virus   - name of the virus which was found

$filter  - name of the filterfile, the matched line and related usefull
           information
