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