README
1Jesred 1.0, Copyright (C) 1998 Jens Elkner (elkner@ivs.cs.uni-magdeburg.de)
2 http://ivs.cs.uni-magdeburg.de/~elkner/webtools/jesred/
3
4This program is free software; you can redistribute it and/or
5modify it under the terms of the GNU General Public License
6as published by the Free Software Foundation; either version 2
7of the License, or (at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14http://www.gnu.org/copyleft/gpl.html or ./gpl.html
15
16You should have received a copy of the GNU General Public License
17along with this program; if not, write to the Free Software
18Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19
20------------------ Jesred is a Squid redirector program. -------------------
21
22It is derived from Chris Foote's
23and Wayne Piekarski's squirm 1.0 betaB (see http://www.senet.com.au/squirm/)
24and uses some slightly modified routines (IP ACL stuff) from squid (see
25http://squid.nlanr.net).
26
27For more information about Squid redirectors see
28http://squid.nlanr.net/Squid/FAQ/FAQ-14.html
29
30Main improvements wrt. squirm 1.0 betaB:
31=========================================
32 - uses a configuration file (jesred.conf)
33 - strict usage of subnet/mask notation and squid's ip acl lists to determine,
34 whether to rewrite the passed URL for a specific client/sibling or not
35 (probably a big plus for Class A and B networks)
36 - optionally allows to rewrite URL's for siblings as well
37 - optionally logging of common and error messages to a file
38 - optionally logging of URL rewrites to a separate file
39 - avoids persistent opening/closing of the log file[s]
40 - supports reconfiguration via 'kill -HUP pid' and re-reads the complete
41 configuration file, and that's why it is able to change the following
42 on the fly, i.e. no need to restart squid:
43 - change the used log file[s] (useful for log file rotation - just
44 rewrite jesred.conf and send a HUP signal to jesred processes)
45 - enable/disable logging
46 - enable/disable debug mode if compiled with DEBUG option
47 - enable/disable URL rewriting of ICP_QUERY (sibling) requests
48 ******************************************
49 - finally: * ABOUT TWICE AS FAST as squirm 1.0betaB *
50 ******************************************
51 (even with ICP_QUERY URL rewriting it was still twice as fast as squirm -
52 remember: squirm allows to rewrite GET requests only! I tested with
53 the extract of the first 100.000 entries from our parent cache's
54 access.log file and our class B subnet - i.e. 141.44.0.0/16 )
55
56Main drawback wrt. squirm 1.0 betaB:
57=====================================
58 - it uses about 256 KB more than squirm on solaris 2.6
59 (but anyway, it is still less than perl 5.004 ;-))
60
61