Written Id-strings inside.
[redirector-ad.git] / README
1 Banner killer by 'squid redirector', version 1.0
2 ------------------------------------------------
3
4 $Id$
5
6 For this software you need the following packages:
7
8 * squid
9 * apache
10 * perl
11 * m4
12 * netpbm (pbmtext, pnmcrop, pnmmargin, pnminvert, ppmtogif)
13
14 I will use /usr/local/squid/ path in the following text, please update it
15 according to your installation (is is also specified in "redirector" script!).
16
17 To install this package:
18
19 * Specify the redirector for squid in its "/usr/local/squid/etc/squid.conf":
20
21   --------------------------------- CUT HERE ---------------------------------
22   #  TAG: redirect_program
23   #       Specify the location of the executable for the URL redirector.
24   #       Since they can perform almost any function there isn't one included.
25   #       See the Release-Notes for information on how to write one.
26   #       By default, a redirector is not used.
27   #
28   redirect_program /usr/local/squid/etc/redirector
29   --------------------------------- CUT HERE ---------------------------------
30
31 * move/copy "redirector" script and "ad" directory to "/usr/local/squid/etc/".
32
33 * move/copy "redirector-ad.cgi" script to "/var/www/cgi-bin",
34   "/usr/local/httpd/cgi-bin" or similiar (according to your installation).
35   Simply - the following URL must access this script correctly:
36       http://localhost/cgi-bin/redirector-ad.cgi
37
38
39 And everything should be OK, just restart your squid, please. Sometimes some
40 banner may miss through the regex rules, just update your
41 "/usr/local/squid/etc/db/main" file and the ALWAYS restart squid (if you are
42 running it by "RunCache" script, just type "killall squid").
43
44
45 Author
46 ------
47
48 These scripts use some databases of other banner killers - please see "ad/main"
49 file for its URL references.
50
51 Files "ad/main", "redirector", "redirector-ad.cgi" and "README" are considered
52 public domain. Their original author is:
53
54 Name:       Jan Kratochvil
55
56 Homepage:   http://atrey.karlin.mff.cuni.cz/~short/
57
58 e-Mail:     short@ucw.cz
59
60 Phone:      +420602431329 or
61             +420603431329 or
62             +420608020202