1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
4 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
8 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
10 $Id: user-manual.sgml,v 1.9 2001/09/27 23:50:29 hal9 Exp $
12 Written by and Copyright (C) 2001 the SourceForge
13 IJBSWA team. http://ijbswa.sourceforge.net
15 Based on the Internet Junkbuster originally written
16 by and Copyright (C) 1997 Anonymous Coders and
17 Junkbusters Corporation. http://www.junkbusters.com
21 Sun 09/23/01 08:53:31 PM
23 This is an unfinished, rough draft. Anyone reading this, believe let me
24 know errors!!!!! Stefan, especially you!
26 Hal Burgiss <hal@foobox.net>
31 <title>Junkbuster User Manual</title>
33 <pubdate>$Id: user-manual.sgml,v 1.9 2001/09/27 23:50:29 hal9 Exp $</pubdate>
38 <orgname>By: Junkbuster Developers</orgname>
45 The user manual gives the users information on how to install and configure
46 <application>Internet Junkbuster</application>. <application>Internet
47 Junkbuster</application> is an application that provides privacy and
48 security to users of the World Wide Web.
51 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/doc/user-manual/">http://ijbswa.sourceforge.net/doc/user-manual/</ulink>.
55 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
62 <!-- ~~~~~ New section ~~~~~ -->
64 <sect1 id="introduction"><title>Introduction</title>
66 <application>Internet Junkbuster</application> is a web proxy with advanced
67 filtering capabilities for protecting privacy, filtering web page content,
68 managing cookies and removing ads, banners, pop-ups and other obnoxious
69 Internet Junk. <application>Junkbuster</application> has a very flexible
70 configuration and can be customized to suit individual needs and tastes.
71 <application>Internet Junkbuster</application> has application for both
72 stand-alone systems and multi-user networks.
76 This documentation is included with the current development version of
77 <application>Internet Junkbuster</application> and is incomplete at this
78 point. The most up to date reference for the time being is still the comments
79 in the source files and in the individual configuration files. Development
80 of version 3.0 is currently underway, and includes significant changes and
81 enhancements over earlier verions. The target release date for stable v3.0 is
86 Since this is a development version, some features are in the process of
87 being implemented. And there <emphasis>are</emphasis> bugs!
91 <!-- ~~~~~ New section ~~~~~ -->
93 <title>New Features</title>
95 In addition to <application>Junkbuster's</application> traditional features
96 of ad and banner blocking and cookie management, this is a list of new
97 features currently under development:
105 Modularized configuration that will allow for system wide settings, and
106 individual user settings.
112 A web based GUI configuration utility.
118 Blocking of annoying pop-up browser windows (previously available as a
125 Support for HTTP 1.1.
131 Support for Perl Compatible Regular Expressions in the configuration files, and
132 generally a more sophisticated configuration syntax.
138 Web page content filtering.
148 <!-- ~~~~~ New section ~~~~~ -->
150 <title>New Features</title>
152 In addition to <application>Junkbuster's</application> traditional features
153 of ad and banner blocking and cookie management, this is a list of new
154 features currently under development:
162 Modularized configuration that will allow for system wide settings, and
163 individual user settings.
169 A web based GUI configuration utility.
175 Blocking of annoying pop-up browser windows (previously available as a
183 Support for HTTP 1.1.
189 Support for Perl Compatible Regular Expressions in the configuration files, and
190 generally a more sophisticated configuration syntax.
196 Web page content filtering.
206 <!-- ~ End section ~ -->
209 <!-- ~~~~~ New section ~~~~~ -->
210 <sect1 id="installation"><title>Installation</title>
212 <application>Junkbuster</application> is available as raw source code, or
213 pre-compiled binaries. See the <ulink
214 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
215 for current releases. <application>Junkbuster</application> is also available
217 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
218 This is the recommended approach at this time. But please be aware that CVS
219 is constantly changing, and it may break in mysterious ways.
222 <!-- ~~~~~ New section ~~~~~ -->
223 <sect2 id="installation-source"><title>Source</title>
225 For gzipped tar archives, unpack the source:
230 tar zxvf ijb_source_2.9*
236 For retrieving the current CVS sources, you'll need the CVS
237 package installed first. To download CVS source:
242 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
243 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
249 This will create a directory named <filename>current/</filename>, which will
250 contain the source tree.
254 Then, in either case, to build from source:
267 For Redhat and SuSE Linux RPM packages, see below.
273 <!-- ~~~~~ New section ~~~~~ -->
274 <sect2 id="installation-rh"><title>Red Hat</title>
276 To build Redhat RPM packages, install source as above. Then:
287 This will create both binary and src RPMs in the usual places. Example:
291 /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
294 /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm
298 To install, of course:
303 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
308 This will place the <application>Junkbuster</application> configuration
309 files in <filename>/etc/junkbuster/</filename>, and log files in
310 <filename>/var/log/junkbuster/</filename>.
315 <!-- ~~~~~ New section ~~~~~ -->
316 <sect2 id="installation-suse"><title>SuSE</title>
318 To build SuSE RPM packages, install source as above. Then:
329 This will create both binary and src RPMs in the usual places. Example:
333 /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
336 /usr/src/suse/SRPMS/junkbuster-2.9.8-1.src.rpm
340 To install, of course:
345 rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
350 This will place the <application>Junkbuster</application> configuration
351 files in <filename>/etc/junkbuster/</filename>, and log files in
352 <filename>/var/log/junkbuster/</filename>.
358 <!-- ~~~~~ New section ~~~~~ -->
359 <sect2 id="installation-os2"><title>OS/2</title>
366 The OS/2 version of <application>Junkbuster</application> requires the EMX
367 runtime library to be installed. The EMX runtime library is available on
368 the hobbes OS/2 archive, among many other locations:
369 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d</ulink>
373 <application>Junkbuster</application> is packaged in a WarpIN self-
374 installing archive. The self-installing program will be named depending
375 on the release version, something like:
376 <filename>ijbos123.exe</filename>. In order to install it, simply run
377 this executable or double-click on its icon and follow the WarpIN
378 installation panels. A shadow of the <application>Junkbuster</application>
379 executable will be placed in your startup folder so it will start
380 automatically whenever OS/2 starts.
384 The directory you choose to install <application>Junkbuster</application>
385 into will contain all of the configuration files.
389 If you would like to build binary images on OS/2 yourself, you will need
390 a working EMX/GCC environment, plus several Unix-like tools. The Hobbes
391 OS/2 archive is a good place to start when building such an environment.
392 A set of Unix-like tools named gnupack is located here:
393 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps</ulink>
396 Once you have the source code unpacked as above, you can build the binaries
397 from the <filename>current/</filename> directory:
411 <!-- ~~~~~ New section ~~~~~ -->
412 <sect2 id="installation-win"><title>Windows</title>
413 <para>I need help on this. Not a clue here. Also for
414 configuration section below.
418 <!-- ~~~~~ New section ~~~~~ -->
419 <sect2 id="installation-other"><title>Other</title>
421 Some quick notes on other Operating Systems.
425 For FreeBSD (and other *BSDs?), the build will need <command>gmake</command>
426 instead of the included <command>make</command>. <command>gmake</command> is
427 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
428 The rest should be the same as above for Linux/Unix.
435 <!-- ~ End section ~ -->
438 <!-- ~~~~~ New section ~~~~~ -->
439 <sect1 id="configuration"><title>Junkbuster Configuration</title>
441 For Unix, *BSD and Linux, all configuraton files are located in
442 <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
443 these are all in the same directory as the
444 <application>Junkbuster</application> executable. The name and number of
445 configuration files has changed from previous versions, and is subject to
446 change as development progresses.
450 The installed defaults provide a reasonable starting point. For the
451 time being, there are only three default configuration files (this will
460 The main configuration file is named <filename>config</filename>
461 on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
468 The <filename>actionsfile</filename> file is used to define various
469 actions relating to images, banners, pop-ups, banners and cookies.
475 The <filename>re_filterfile</filename> file can be used to rewrite the raw
476 page content, including text as well as embedded HTML and JavaScript.
484 <filename>actionsfile</filename> and <filename>re_filterfile</filename>
485 can use Perl style regular expressions for maximum flexibility. All files use
486 the <quote><literal>#</literal></quote> character to denote a comment. Such
487 lines are not processed by <application>Junkbuster</application>. After
488 making any changes, restart <application>Junkbuster</application> in order
489 for the changes to take effect.
493 <!-- ~~~~~ New section ~~~~~ -->
496 <title>The Main Configuration File</title>
498 Again, the main configuration file is named <filename>config</filename> on
499 Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
500 Configuration lines consist of an initial keyword followed by a list of
501 values, all separated by whitespace (any number of spaces or tabs). For
509 <emphasis>blockfile blocklist.ini</emphasis>
516 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
520 The <quote><literal>#</literal></quote> indicates a comment. Any part of a
521 line following a <quote><literal>#</literal></quote> is ignored, except if
522 the <quote><literal>#</literal></quote> is preceded by a
523 <quote><literal>\</literal></quote>.
527 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
528 existing configuration line, you can make it a comment and it will be treated
529 as if it weren't there. This is called <quote>commenting out</quote> an
530 option and can be useful to turn off features: If you comment out the
531 <quote>logfile</quote> line, <application>junkbuster</application> will not
532 log to a file at all. Watch for the <quote>default:</quote> section in each
533 explanation to see what happens if the option is left unset (or commented
538 Long lines can be continued on the next line by using a
539 <quote><literal>\</literal></quote> as the very last character.
543 There are various aspects of <application>Junkbuster</application> behavior
544 that can be adjusted.
548 <!-- ~~~~~ New section ~~~~~ -->
551 <title>Defining Other Configuration Files</title>
554 <application>Junkbuster</application> can use a number of other files to tell it
555 what ads to block, what cookies to accept, etc. This section of the
556 configuration file tells <application>Junkbuster</application> where to find
557 all those other files.
561 On <application>Windows</application>, <application>Junkbuster</application>
562 looks for these files in the same directory as the executable. On Unix and
563 OS/2, <application>Junkbuster</application> looks for these files in the current
564 working directory. In either case, an absolute path name can be used to
569 When development goes modular and multiuser, the blocker, filter, and
570 per-user config will be stored in subdirectories of <quote>confdir</quote>.
571 For now, only <filename>confdir/templates</filename> is used for storing HTML
572 templates for CGI results.
576 The location of the configuration files:
583 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
590 The directory where all logging (i.e. <filename>logfile</filename> and
591 <filename>jarfile</filename>) takes place. No trailing
592 <quote><literal>/</literal></quote>, please:
599 <emphasis>logdir /var/log/junkbuster</emphasis>
606 Note that all file specifications below are relative to
607 the above two directories!
611 The <quote>actionsfile</quote> contains patterns to specify the actions to
612 apply to requests for each site. Default: Cookies to and from all
613 destinations are filtered. Popups are disabled for all sites. All sites are
614 filtered if re_filterfile specified. No sites are blocked. An empty image is
615 displayed for filtered ads and other images (formerly
616 <quote>tinygif</quote>). The syntax of this file is explained in detail
617 <link linkend="actionsfile">below</link>.
624 <emphasis>actionsfile actionsfile</emphasis>
631 The <quote>re_filterfile</quote> file contains content modification rules.
632 These rules permit powerful changes on the content of Web pages, e.g., you
633 could disable your favourite JavaScript annoyances, rewrite the actual
634 content, or just have some fun replacing <quote>Microsoft</quote> with
635 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
636 content modification, or whatever the developers are playing with :-/
643 <emphasis>re_filterfile re_filterfile</emphasis>
650 The logfile is where all logging and error messages are written. The logfile
651 can be useful for tracking down a problem with
652 <application>Junkbuster</application> (e.g., it's not blocking an ad you
653 think it should block) but in most cases you probably will never look at it.
657 Your logfile will grow indefinitely, and you will probably want to
658 periodically remove it. On Unix systems, you can do this with a cron job
659 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
660 script has been included.
664 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
665 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
666 the effect that cron.daily will automatically archive, gzip, and empty the
667 log, when it exceeds 1M size.
671 Default: Log to the a file named <filename>logfile</filename>.
672 Comment out to disable logging.
679 <emphasis>logfile logfile</emphasis>
686 The <quote>jarfile</quote> defines where
687 <application>Junkbuster</application> stores the cookies it intercepts. Note
688 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
689 Don't store intercepted cookies.
696 <emphasis>#jarfile jarfile</emphasis>
703 If you specify a <quote>trustfile</quote>,
704 <application>Junkbuster</application> will only allow access to sites that
705 are named in the trustfile. You can also mark sites as trusted referrers,
706 with the effect that access to untrusted sites will be granted, if a link
707 from a trusted referrer was used. The link target will then be added to the
708 <quote>trustfile</quote>. This is a very restrictive feature that typical
709 users most propably want to leave disabled. Default: Disabled, don't use the
717 <emphasis>#trustfile trust</emphasis>
724 If you use the trust mechanism, it is a good idea to write up some online
725 documentation about your blocking policy and to specify the URL(s) here. They
726 will appear on the page that your users receive when they try to access
727 untrusted content. Use multiple times for multiple URLs. Default: Don't
728 display links on the <quote>untrusted</quote> info page.
735 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
736 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
744 <!-- ~ End section ~ -->
748 <!-- ~~~~~ New section ~~~~~ -->
751 <title>Other Configuration Options</title>
754 This part of the configuration file contains options that control how
755 <application>Junkbuster</application> operates.
759 <quote>Admin-address</quote> should be set to the email address of the proxy
760 administrator. It is used in many of the proxy-generated pages. Default:
768 <emphasis>#admin-address fill@me.in.please</emphasis>
775 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
776 about this <application>Junkbuster</application> installation, it's
777 configuration and policies. It is used in many of the proxy-generated pages
778 and its use is highly recommended in multi-user installations, since your
779 users will want to know why certain content is blocked or modified. Default:
780 Don't show a link to online documentation.
787 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
794 <quote>Listen-address</quote> specifies the address and port where
795 <application>Junkbuster</application> will listen for connections from your
796 Web browser. The default is to listen on the localhost port 8000, and
797 this is suitable for most users. (In your web browser, under proxy
798 configuration, list the proxy server as <quote>localhost</quote> and the
799 port as <quote>8000</quote>).
803 If you already have another service running on port 8000, or if you want to
804 serve requests from other machines (e.g. on your local network) as well, you
805 will need to override the default. The syntax is
806 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
807 out the IP adress, <application>junkbuster</application> will bind to all
808 interfaces (addresses) on your machine and may become reachable from the
809 internet. In that case, consider using access control lists (acl's) (see
810 <quote>aclfile</quote> above).
814 For example, suppose you are running <application>Junkbuster</application> on
815 a machine which has the address 192.168.0.1 on your local private network
816 (192.168.0.0) and has another outside connection with a different address.
817 You want it to serve requests from inside only:
824 <emphasis>listen-address 192.168.0.1:8000</emphasis>
831 If you want it to listen on all addresses (including the outside
839 <emphasis>listen-address :8000</emphasis>
846 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
847 you will need to point your browser(s) to the address and port that you have
848 configured here. Default: localhost:8000 (127.0.0.1:8000).
852 The debug option sets the level of debugging information to log in the
853 logfile (and to the console in the Windows version). A debug level of 1 is
854 informative because it will show you each request as it happens. Higher
855 levels of debug are probably only of interest to developers.
862 debug 1 # GPC = show each GET/POST/CONNECT request
863 debug 2 # CONN = show each connection status
864 debug 4 # IO = show I/O status
865 debug 8 # HDR = show header parsing
866 debug 16 # LOG = log all data into the logfile
867 debug 32 # FRC = debug force feature
868 debug 64 # REF = debug regular expression filter
869 debug 128 # = debug fast redirects
870 debug 256 # = debug GIF deanimation
871 debug 512 # CLF = Common Log Format
872 debug 1024 # = debug kill popups
873 debug 4096 # INFO = Startup banner and warnings.
874 debug 8192 # ERROR = Non-fatal errors
881 It is <emphasis>highly recommended</emphasis> that you enable ERROR
882 reporting (debug 8192), at least until the next stable release.
886 The reporting of FATAL errors (i.e. ones which crash
887 <application>JunkBuster</application>) is always on and cannot be disabled.
891 If you want to use CLF (Common Log Format), you should set <quote>debug
892 512</quote> ONLY, do not enable anything else.
896 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
904 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
918 <emphasis>debug 1 # URLs</emphasis>
919 <emphasis>debug 4096 # Info</emphasis>
920 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
927 <application>Junkbuster</application> normally uses
928 <quote>multi-threading</quote>, a software technique that permits it to
929 handle many different requests simultaneously. In some cases you may wish to
930 disable this -- particularly if you're trying to debug a problem. The
931 <quote>single-threaded</quote> option forces
932 <application>Junkbuster</application> to handle requests sequentially.
933 Default: Multi-threaded mode.
940 <emphasis>#single-threaded</emphasis>
947 <quote>toggle</quote> allows you to temporarily disable all
948 <application>Junkbuster's</application> filtering. Just set <quote>toggle
953 The Windows version of <application>Junkbuster</application> puts an icon in
954 the system tray, which allows you to change this option without having to
955 edit this file. If you right-click on that icon (or select the
956 <quote>Options</quote> menu), one choice is <quote>Enable</quote>. Clicking
957 on enable toggles <application>Junkbuster</application> on and off. This is
958 useful if you want to temporarily disable
959 <application>Junkbuster</application>, e.g., to access a site that requires
960 cookies which you normally have blocked.
964 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
965 normally, <quote>toggle 0</quote> means that
966 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
974 <emphasis>toggle 1</emphasis>
982 <!-- ~ End section ~ -->
985 <!-- ~~~~~ New section ~~~~~ -->
988 <title>Access Control List (ACL)</title>
990 Access controls are included at the request of some ISPs and systems
991 administrators, and are not usually needed by individual users. Please note
992 the warnings in the FAQ that this proxy is not intended to be a substitute
993 for a firewall or to encourage anyone to defer addressing basic security
998 If no access settings are specified, the proxy talks to anyone that
999 connects. If any access settings file are specified, then the proxy
1000 talks only to IP addresses permitted somewhere in this file and not
1001 denied later in this file.
1005 Summary -- if using an ACL:
1010 Client must have permission to receive service.
1015 LAST match in ACL wins.
1020 Default behavior is to deny service.
1025 The syntax for an entry in the Access Control List is:
1032 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1039 Where the individual fields are:
1046 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1048 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1049 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1051 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1052 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1060 The field separator (FS) is whitespace (space or tab).
1064 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1065 forwarder (see below) or a gateway for a particular destination URL, the
1066 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1067 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1068 target. This is necessary because it may be impossible for the local
1069 <application>Junkbuster</application> to determine the address of the
1070 ultimate target (that's often what gateways are used for).
1074 Here are a few examples to show how the ACL features work:
1078 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1079 <emphasis>ALL</emphasis> destination addresses are OK:
1086 <emphasis>permit-access localhost</emphasis>
1093 A silly example to illustrate permitting any host on the class-C subnet with
1094 <application>Junkbuster</application> to go anywhere:
1101 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1108 Except deny one particular IP address from using it at all:
1115 <emphasis>deny-access ident.junkbusters.com</emphasis>
1122 You can also specify an explicit network address and subnet mask.
1123 Explicit addresses do not have to be resolved to be used.
1130 <emphasis>permit-access 207.153.200.0/24</emphasis>
1137 A subnet mask of 0 matches anything, so the next line permits everyone.
1144 <emphasis>permit-access 0.0.0.0/0</emphasis>
1151 Note, you <emphasis>cannot</emphasis> say:
1158 <emphasis>permit-access .org</emphasis>
1165 to allow all *.org domains. Every IP address listed must resolve fully.
1169 An ISP may want to provide a <application>Junkbuster</application> that is
1170 accessible by <quote>the world</quote> and yet restrict use of some of their
1171 private content to hosts on its internal network (i.e. its own subscribers).
1172 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1173 bit netmask). This is how they could do it:
1180 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1181 # with the following exceptions:
1183 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1184 # sites on the ISP's network
1186 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1189 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1197 Note that if some hostnames are listed with multiple IP addresses,
1198 the primary value returned by DNS (via gethostbyname()) is used. Default:
1199 Anyone can access the proxy.
1204 <!-- ~ End section ~ -->
1207 <!-- ~~~~~ New section ~~~~~ -->
1210 <title>Forwarding</title>
1213 This feature allows routing of HTTP requests via multiple proxies.
1214 It can be used to better protect privacy and confidentiality when
1215 accessing specific domains by routing requests to those domains
1216 to a special purpose filtering proxy such as lpwa.com.
1220 It can also be used in an environment with multiple networks to route
1221 requests via multiple gateways allowing transparent access to multiple
1222 networks without having to modify browser configurations.
1226 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1227 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1228 hostname using DNS on the SOCKS server, not our local DNS client.
1232 The syntax of each line is:
1239 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1240 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1241 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1248 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1249 HTTP proxy but are made directly to the web servers.
1253 Lines are checked in sequence, and the last match wins.
1257 There is an implicit line equivalent to the following, which specifies that
1258 anything not finding a match on the list is to go out without forwarding
1259 or gateway protocol, like so:
1266 <emphasis>forward .* . </emphasis># implicit
1273 In the following common configuration, everything goes to Lucent's LPWA,
1274 except SSL on port 443 (which it doesn't handle):
1281 <emphasis>forward .* lpwa.com:8000</emphasis>
1282 <emphasis>forward :443 .</emphasis>
1289 See the FAQ for instructions on how to automate the login procedure for LPWA.
1290 Some users have reported difficulties related to LPWA's use of
1291 <quote>.</quote> as the last element of the domain, and have said that this
1292 can be fixed with this:
1299 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1306 (NOTE: the syntax for specifiying target_domain has changed since the
1307 previous paragraph was written -- it will not work now. More information
1312 In this fictitious example, everything goes via an ISP's caching proxy,
1313 except requests to that ISP:
1320 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1321 <emphasis>forward myisp.net .</emphasis>
1328 For the @home network, we're told the forwarding configuration is this:
1336 <emphasis>forward .* proxy:8080</emphasis>
1343 Also, we're told they insist on getting cookies and JavaScript, so you need
1344 to add home.com to the cookie file. We consider JavaScript a security risk.
1345 Java need not be enabled.
1349 In this example direct connections are made to all <quote>internal</quote>
1350 domains, but everything else goes through Lucent's LPWA by way of the
1351 company's SOCKS gateway to the Internet.
1358 <emphasis>forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1359 <emphasis>forward my_company.com .</emphasis>
1366 This is how you could set up a site that always uses SOCKS but no forwarders:
1373 <emphasis>forward_socks4a .* . firewall.my_company.com:1080</emphasis>
1380 An advanced example for network administrators:
1384 If you have links to multiple ISPs that provide various special content to
1385 their subscribers, you can configure forwarding to pass requests to the
1386 specific host that's connected to that ISP so that everybody can see all
1387 of the content on all of the ISPs.
1391 This is a bit tricky, but here's an example:
1396 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1397 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1398 forwarding like this:
1405 <emphasis>forward .* .</emphasis>
1406 <emphasis>forward isp-b.com host-b:8000</emphasis>
1413 host-b can run a <application>Junkbuster</application> proxy with forwarding
1421 <emphasis>forward .* .</emphasis>
1422 <emphasis>forward isp-a.com host-a:8000</emphasis>
1429 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1430 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1431 host-a or host-b and be able to browse the content on isp-a or isp-b.
1435 Here's another practical example, for University of Kent at
1436 Canterbury students with a network connection in their room, who
1437 need to use the University's Squid web cache.
1444 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1445 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1446 <emphasis>forward * . </emphasis> # Host with no domain specified
1447 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1448 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1449 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1450 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1457 If you intend to chain <application>Junkbuster</application> and
1458 <application>squid</application> locally, then chain as
1459 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1463 Your squid configuration could then look like this:
1470 # Define junkbuster as parent cache
1471 cache_peer 127.0.0.1 8000 parent 0 no-query
1473 # Define ACL for protocol FTP
1476 # Do not forward ACL FTP to junkbuster
1477 always_direct allow FTP
1479 # Do not forward ACL CONNECT (https) to junkbuster
1480 always_direct allow CONNECT
1482 # Forward the rest to junkbuster
1483 never_direct allow all
1491 <!-- ~ End section ~ -->
1494 <!-- ~~~~~ New section ~~~~~ -->
1497 <title>Windows GUI Options</title>
1499 Removed references to Win32. HB 09/23/01
1502 <application>Junkbuster</application> has a number of options specific to the
1503 Windows GUI interface:
1507 If <quote>activity-animation</quote> is set to 1, the
1508 <application>Junkbuster</application> icon will animate when
1509 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1516 <emphasis>activity-animation 1</emphasis>
1523 If <quote>log-messages</quote> is set to 1,
1524 <application>Junkbuster</application> will log messages to the console
1532 <emphasis>log-messages 1</emphasis>
1539 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1540 i.e. the amount of memory used for the log messages displayed in the
1541 console window, will be limited to <quote>log-max-lines</quote> (see below).
1545 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1546 eat up all your memory!
1553 <emphasis>log-buffer-size 1</emphasis>
1560 <application>log-max-lines</application> is the maximum number of lines held
1561 in the log buffer. See above.
1568 <emphasis>log-max-lines 200</emphasis>
1575 If <quote>log-highlight-messages</quote> is set to 1,
1576 <application>Junkbuster</application> will highlight portions of the log
1577 messages with a bold-faced font:
1584 <emphasis>log-highlight-messages 1</emphasis>
1591 The font used in the console window:
1598 <emphasis>log-font-name Comic Sans MS</emphasis>
1605 Font size used in the console window:
1612 <emphasis>log-font-size 8</emphasis>
1619 <quote>show-on-task-bar</quote> controls whether or not
1620 <application>Junkbuster</application> will appear as a button on the Task bar
1628 <emphasis>show-on-task-bar 0</emphasis>
1635 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1636 button will minimize <application>Junkbuster</application> instead of closing
1637 the program (close with the exit option on the File menu).
1644 <emphasis>close-button-minimizes 1</emphasis>
1651 The <quote>hide-console</quote> option is specific to the MS-Win console
1652 version of <application>JunkBuster</application>. If this option is used,
1653 <application>Junkbuster</application> will disconnect from and hide the
1670 <!-- ~ End section ~ -->
1673 <!-- ~~~~~ New section ~~~~~ -->
1674 <sect2 id="actionsfile">
1675 <title>The Actions File</title>
1678 The <quote>actionsfile</quote> is used to define what actions
1679 <application>Junkbuster</application> takes, and thus determines how images,
1680 cookies and various other aspects of HTTP content and transactions are
1681 handled. Images can be anything you want, including ads, banners, or just
1682 some obnoxious image that you would rather not see. Cookies can be accepted
1683 or rejected. The default file is in fact named <filename>actionsfile</filename>.
1687 To determine which actions apply to a request, the URL of the request is
1688 compared to all patterns in this file. Every time it matches, the list of
1689 applicable actions for the URL is incrementally updated. You can trace
1690 this process by visiting <ulink
1691 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1695 There are four types of lines in this file: comments (begin with a
1696 <quote>#</quote> character), actions, aliases and patterns, all of which are
1701 <!-- ~~~~~ New section ~~~~~ -->
1703 <title>URL Domain and Path Syntax</title>
1705 Generally, a pattern has the form <domain>/<path>, where both the
1706 <domain> and <path> part are optional. If you only specify a
1707 domain part, the <quote>/</quote> can be left out:
1711 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1712 <quote>www.example.com</quote>.
1716 <emphasis>www.example.com/</emphasis> - means exactly the same.
1720 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1721 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1725 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1730 <emphasis>index.html</emphasis> - matches nothing, since it would be
1731 interpreted as a domain name and there is no top-level domain called
1732 <quote>.html</quote>.
1736 The matching of the domain part offers some flexible options: if the
1737 domain starts or ends with a dot, it becomes unanchored at that end.
1742 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1743 <quote>.example.com</quote>.
1747 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1752 Additionally, there are wildcards that you can use in the domain names
1753 themselves. They work pretty similar to shell wildcards: <quote>*</quote>
1754 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1755 any single character. And you can define charachter classes in square
1756 brackets and they can be freely mixed:
1760 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1761 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1765 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1769 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1770 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1774 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1775 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1776 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1777 <quote>wwww.example.com</quote>.
1781 If <application>Junkbuster</application> was compiled with
1782 <quote>pcre</quote> support (default), Perl compatible regular expressions
1783 can be used. See the <filename>pcre/docs/</filename> direcory or <quote>man
1784 perlre</quote> (also available on <ulink
1785 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1786 for details. A brief discussion of regular expressions is in the
1787 <link linkend="regex">Appendix</link>. For instance:
1791 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1792 domain, with any path that includes <quote>advert</quote> followed
1793 immediately by one or more digits, then a <quote>.</quote> and ending in
1794 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1795 <quote>example.com/ads/advert2.jpg</quote>, and
1796 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1797 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1802 Please note that matching in the path is case
1803 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1804 sensitive at any point in the pattern by using the
1805 <quote>(?-i)</quote> switch:
1809 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1810 documents whose path starts with <quote>PaTtErN</quote> in
1811 <emphasis>exactly</emphasis> this capitalization.
1816 <!-- ~ End section ~ -->
1820 <!-- ~~~~~ New section ~~~~~ -->
1823 <title>Actions</title>
1825 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1826 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1827 action name in curly braces (e.g. {+some_action}), followed by a list of
1828 URLs to which the action applies. There are three classes of actions:
1836 Boolean (e.g. <quote>+/-block</quote>):
1842 <emphasis>{+name}</emphasis> # enable this action
1843 <emphasis>{-name}</emphasis> # disable this action
1853 Parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1859 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1860 <emphasis>{-name}</emphasis> # disable action
1869 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1875 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1876 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1877 <emphasis>{-name}</emphasis> # disable this action totally
1888 If nothing is specified in this file, no <quote>actions</quote> are taken.
1889 So in this case <application>JunkBuster</application> would just be a
1890 normal, non-blocking, non-anonymizing proxy. You must specifically
1891 enable the privacy and blocking features you need (although the
1892 provided default <filename>actionsfile</filename> file will
1893 give a good starting point).
1897 Later defined actions always over-ride earlier ones. For multi-valued
1898 actions, the actions are applied in the order they are specified.
1902 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
1910 Add the specified HTTP header, which is not checked for validity.
1911 You may specify this many times to specify many different headers:
1917 <emphasis>+add-header{Name: value}</emphasis>
1927 Block this URL totally.
1933 <emphasis>+block</emphasis>
1943 De-animate all animated GIF images, i.e. reduce them to their last frame.
1944 This will also shrink the images considerably (in bytes, not pixels!). If
1945 the option <quote>first</quote> is given, the first frame of the animation
1946 is used as the replacement. If <quote>last</quote> is given, the last frame
1947 of the animation is used instead, which propably makes more sense for most
1948 banner animations, but also has the risk of not showing the entire last
1949 frame (if it is only a delta to an earlier frame).
1955 <emphasis>+deanimate-gifs{last}</emphasis>
1956 <emphasis>+deanimate-gifs{first}</emphasis>
1965 Many sites, like yahoo.com, don't just link to other sites. Instead, they
1966 will link to some script on their own server, giving the destination as a
1967 parameter, which will then redirect you to the final target. URLs resulting
1968 from this scheme typically look like:
1969 http://some.place/some_script?http://some.where-else.
1972 Sometimes, there are even multiple consecutive redirects encoded in the
1973 URL. These redirections via scripts make your web browing more traceable,
1974 since the server from which you follow such a link can see where you go to.
1975 Apart from that, valuable bandwidth and time is wasted, while your browser
1976 ask the server for one redirect after the other. Plus, it feeds the
1980 The <quote>+fast-redirects</quote> option enables interception of these
1981 requests by <application>Junkbuster</application>, who will cut off all but
1982 the last valid URL in the request and send a local redirect back to your
1983 browser without contacting the remote site.
1989 <emphasis>+fast-redirects</emphasis>
1998 Filter the website through the re_filterfile:
2004 <emphasis>+filter{filename}</emphasis>
2013 Block any existing X-Forwarded-for header, and do not add a new one:
2019 <emphasis>+hide-forwarded</emphasis>
2028 If the browser sends a <quote>From:</quote> header containing your e-mail
2029 address, this either completely removes the header (<quote>block</quote>), or
2030 changes it to the specified e-mail address.
2036 <emphasis>+hide-from{block}</emphasis>
2037 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2046 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2047 can block it, forge a URL to the same server as the request (which is
2048 preferred because some sites will not send images otherwise) or set it to a
2049 constant string of your choice.
2055 <emphasis>+hide-referer{block}</emphasis>
2056 <emphasis>+hide-referer{forge}</emphasis>
2057 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2066 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2067 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2068 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2069 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2075 <emphasis>+hide-referrer{...}</emphasis>
2084 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2085 browser type. Warning! This breaks many web sites. Specify the
2086 user-agent value you want. Example, pretend to be using Netscape on
2093 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2100 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2106 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2111 (Don't change the version number from 1.0 - after all, why tell them?)
2118 <emphasis>+hide-user-agent{browser-type}</emphasis>
2128 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2129 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2130 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2136 <emphasis>+image</emphasis>
2145 Decides what to do with URLs that end up tagged with <quote>{+block
2146 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2147 send a HTML <quote>blocked</quote> page, usually resulting in a
2148 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2149 send a <quote>JunkBuster</quote> image.
2150 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2151 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2152 temporary redirect to the specified image. This has the advantage of the
2153 icon being being cached by the browser, which will speed up the display.
2159 <emphasis>+image-blocker{logo}</emphasis>
2160 <emphasis>+image-blocker{blank}</emphasis>
2161 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2170 Prevent the website from reading cookies:
2176 <emphasis>+no-cookies-read</emphasis>
2185 Prevent the website from setting cookies:
2191 <emphasis>+no-cookies-set</emphasis>
2200 Filter the website through a built-in filter to disable those obnoxious
2201 JavaScript pop-up windows via window.open(), etc. The two alternative
2202 spellings are equivalent.
2208 <emphasis>+no-popup</emphasis>
2209 <emphasis>+no-popups</emphasis>
2218 This action only applies if you are using a <filename>jarfile</filename>
2219 for saving cookies. It sends a cookie to every site stating that you do not
2220 accept any copyright on cookies sent to you, and asking them not to track
2221 you. Of course, this is a (relatively) unique header they could use to
2228 <emphasis>+vanilla-wafer</emphasis>
2237 This allows you to add an arbitrary cookie. It can be specified multiple
2238 times in order to add as many cookies as you like.
2244 <emphasis>+wafer{name=value}</emphasis>
2255 The meaning of any of the above is reversed by preceding the action with a
2256 <quote>-</quote>, in place of the <quote>+</quote>.
2264 Turn off cookies by default, then allow a few through for specified sites:
2271 # Turn off all cookies
2272 { +no-cookies-read }
2275 # Execeptions to the above, sites that need cookies
2276 { -no-cookies-read }
2284 # Alternative way of saying the same thing
2285 {-no-cookies-set -no-cookies-read}
2294 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2304 # Reverse it for these two sites, which don't work right without it.
2306 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2314 Turn on page filtering, with one exception for sourceforge:
2321 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2324 # But please don't re_filter code from sourceforge!
2326 .cvs.sourceforge.net
2333 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2334 Many of these use regular expressions that will expand to match multiple
2344 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2345 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2346 /.*/(ng)?adclient\.cgi
2347 /.*/(plain|live|rotate)[-_.]?ads?/
2348 /.*/(sponsor)s?[0-9]?/
2349 /.*/_?(plain|live)?ads?(-banners)?/
2351 /.*/ad(sdna_image|gifs?)/
2352 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2356 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2360 /.*/cgi-bin/centralad/getimage
2361 /.*/images/addver\.gif
2362 /.*/images/marketing/.*\.(gif|jpe?g)
2366 /.*/sponsors?[0-9]?/
2367 /.*/advert[0-9]+\.jpg
2374 /graphics/defaultAd/
2376 /image\.ng/transactionID
2377 /images/.*/.*_anim\.gif # alvin brattli
2378 /ip_img/.*\.(gif|jpe?g)
2382 /cgi-bin/nph-adclick.exe/
2383 /.*/Image/BannerAdvertising/
2385 /.*/adlib/server\.cgi
2394 <!-- ~ End section ~ -->
2397 <!-- ~~~~~ New section ~~~~~ -->
2399 <title>Aliases</title>
2401 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2402 as <quote>aliases</quote>, can be defined by combing other <quote>actions</quote>.
2403 These can in turn be invoked just like the built-in <quote>actions</quote>.
2404 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2405 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2406 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2407 <quote>-</quote>. Alias names are not case sensitive, and must be defined
2408 before they are used.
2412 Now let's define a few aliases:
2423 +no-cookies = +no-cookies-set +no-cookies-read
2424 -no-cookies = -no-cookies-set -no-cookies-read
2425 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2426 shop = -no-cookies -filter -fast-redirects
2427 +imageblock = +block +image
2429 #For people who don't like to type too much: ;-)
2432 c2 = -no-cookies-set +no-cookies-read
2433 c3 = +no-cookies-set -no-cookies-read
2434 #... etc. Customize to your heart's content.
2441 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2449 # These sites are very complex and require
2450 # minimal interference.
2452 .office.microsoft.com
2453 .windowsupdate.microsoft.com
2455 # Shopping sites - still want to block ads.
2458 .worldpay.com # for quietpc.com
2462 # These shops require pop-ups
2474 <!-- ~ End section ~ -->
2477 <!-- ~~~~~ New section ~~~~~ -->
2478 <sect2 id="filterfile">
2479 <title>The Filter File</title>
2481 The filter file defines what filtering of web pages
2482 <application>Junkbuster</application> does. The default filter file is
2483 <filename>re_filterfile</filename>, located in the config directory. In this
2484 file, <emphasis>any document content</emphasis>, whether viewable text or
2485 embedded non-visible content, can be changed.
2489 This file uses regular expressions to alter or remove any string in the
2490 target page. Some examples from the included default <filename>re_filterfile</filename>:
2494 Stop web pages from displaying annoying messages in the status bar by
2495 deleting such references:
2502 # The status bar is for displaying link targets, not pointless buzzwords.
2503 # Again, check it out on http://www.airport-cgn.de/.
2504 s/status='.*?';*//ig
2511 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2512 <quote>MicroSuck</quote>:
2519 s/microsoft(?!.com)/MicroSuck/ig
2526 Kill those auto-refresh tags:
2533 # Kill refresh tags. I like to refresh myself. Manually.
2534 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2536 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2537 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2547 <!-- ~~~~~ New section ~~~~~ -->
2548 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2550 Install package, then run and enjoy! Be sure your browser is set to use
2551 the proxy which is by default at localhost, port 8000. With
2552 <application>Netscape</application> (and <application>Mozilla</application>),
2553 this can be set under <literal>Edit -> Preferences -> Advanced ->
2554 Proxies -> HTTP Proxy</literal>. For <application>Internet
2555 Explorer</application>: <literal>Internet Properties -> Connections ->
2556 LAN Setting</literal>. Then, check <quote>Use Proxy</quote> and fill in the
2557 appropriate info (Address: localhost, Port: 8000).
2561 The included default configuration files should give a reasonable starting
2562 point, though may be somewhat aggressive in blocking junk. You will probably
2563 want to keep an eye out for sites that require cookies, and add these to
2564 <filename>actionsfile</filename> as needed. By default, most of these will
2565 be blocked until you add them to the configuration. If you want the browser
2566 to handle this, you will need to edit <filename>actionsfile</filename> and
2567 disable this feature. If you use more than one browser, it would make more
2568 sense to let <application>Junkbuster</application> handle this. In which
2569 case, the browser(s) should be set to accept all cookies.
2573 If you encounter problems, please verify it is a
2574 <application>Junkbuster</application> bug, by disabling
2575 <application>Junkbuster</application>, and then trying the same page.
2576 Before reporting it as a bug, see if there is not a configuration
2577 option that is enabled that is causing the page not to load. You can
2578 then add an exception for that page or site. If a bug, please report it to
2579 the developers (see below).
2585 <!-- ~~~~~ New section ~~~~~ -->
2586 <sect1 id="contact"><title>Contact the Developers</title>
2589 To be filled. mention the support forums as the primary channel of
2590 communication (bugs, feature requests, etc.)
2592 Feature requests and other questions should be posted to the <ulink
2593 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
2594 request page</ulink> at SourceForge. There is also an archive there.
2598 Anyone interested in actively participating in development and related
2599 discussions can join the appropriate mailing list
2600 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
2601 Archives are available here too.
2605 Please report bugs, using the form at
2606 <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
2607 Please try to verify that it is a <application>Junkbuster</application> bug,
2608 and not a browser or site bug first. Also, check to make sure this is not
2609 already a known bug.
2615 <!-- ~~~~~ New section ~~~~~ -->
2616 <sect1 id="copyright"><title>Copyright and History</title>
2619 <title>License</title>
2621 <application>Internet Junkbuster</application> is free software; you can
2622 redistribute it and/or modify it under the terms of the GNU General Public
2623 License as published by the Free Software Foundation; either version 2 of the
2624 License, or (at your option) any later version.
2628 This program is distributed in the hope that it will be useful, but WITHOUT
2629 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2630 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2631 details, which is available from <ulink
2632 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
2633 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2638 <!-- ~ End section ~ -->
2641 <!-- ~~~~~ New section ~~~~~ -->
2644 <title>History</title>
2646 <application>Junkbuster</application> was originally written by Anonymous
2648 url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
2649 Corporation</ulink>, and was released as free open-source software under the
2650 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
2651 Waldherr</ulink> made many improvements, and started the <ulink
2652 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
2653 rekindle development. The last stable release was v2.0.2, which has now
2661 <!-- ~~~~~ New section ~~~~~ -->
2662 <sect1 id="seealso"><title>See also</title>
2663 <para>To be filled. What should go here :/
2669 <!-- ~~~~~ New section ~~~~~ -->
2670 <sect1 id="appendix"><title>Appendix</title>
2673 <!-- ~~~~~ New section ~~~~~ -->
2675 <title>Regular Expressions</title>
2677 <application>Junkbuster</application> can use <quote>regular expressions</quote>
2678 in various config files. Assuming support for <quote>pcre</quote> (Perl
2679 Compatible Regular Expressions) is compiled in, which is the default. Such
2680 configuration directives do not require regular expressions, but they can be
2681 used to increase flexibility by matching a pattern with wildcards against
2686 If you are reading this, you probably don't understand what <quote>regular
2687 expressions</quote> are, or what they can do. So this will be a very brief
2688 introduction only. A full explanation would require a book ;-)
2692 <quote>Regular expressions</quote> is a way of matching one character
2693 expression against another to see if it matches or not. One of the
2694 <quote>expressions</quote> is a literal string of readable characters
2695 (letter, numbers, etc), and the other is a complex string of literal
2696 characters combined with wildcards, and other special characters, called
2697 metacharacters. The <quote>metacharacters</quote> have special meanings and
2698 are used to build the complex pattern to be matched against. Perl Compatible
2699 Regular Expressions is an enhanced form of the regular expression language
2700 with backward compatibility.
2704 To make a simple analogy, we do something similar when we use wildcard
2705 characters when listing files with the <command>dir</command> command in DOS.
2706 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
2707 character here is the asterik which matches any and all characters. We can be
2708 more specific and use <literal>?</literal> to match just individual
2709 characters. So <quote>dir file?.text</quote> would match
2710 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
2711 matching, using a similar technique to <quote>regular expressions</quote>!
2715 Regular expressions do essentially the same thing, but are much, much more
2716 powerful. There are many more <quote>special characters</quote> and ways of
2717 building complex patterns however. Let's look at a few of the common ones,
2718 and then some examples:
2723 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
2724 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
2730 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
2737 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
2744 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
2751 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
2752 the following character should be taken literally. This is used where one of the
2753 special characters (e.g. <quote>.</quote>) needs to be taken literally and
2754 not as a special metacharacter.
2760 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
2761 any of the enclosed characters are encountered.
2767 <emphasis>()</emphasis> - Pararentheses are used to group a sub-expression,
2768 or multiple sub-expressions.
2774 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
2775 <quote>or</quote> conditional statement. A match is successful if the
2776 sub-expression on either side of <quote>|</quote> matches.
2782 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
2783 <quote>string1</quote> is replaced by <quote>string2</quote> in this
2789 These are just some of the ones you are likely to use when matching URLs with
2790 <application>Junkbuster</application>, and is a long way from a definitive
2791 list. This is enough to get us started with a few simple examples which may
2792 be more illuminating:
2796 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
2797 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
2798 denote any character, zero or more times. In other words, any string at all.
2799 So we start with a literal forward slash, then our regular expression pattern
2800 (<quote>.*</quote>) another literal forward slash, the string
2801 <quote>banners</quote>, another forward slash, and lastly another
2802 <quote>.*</quote>. We are building
2803 a directory path here. This will match any file with the path that has a
2804 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
2805 any characters, and this could conceivably be more forward slashes, so it
2806 might expand into a much longer looking path. For example, this could match:
2807 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
2808 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
2809 possible combinations, just so it has <quote>banners</quote> in the path
2814 A now something a little more complex:
2818 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
2819 We have several literal forward slashes again (<quote>/</quote>), so we are
2820 building another expression that is a file path statement. We have another
2821 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
2822 it matches our expression. The only true literal that <emphasis>must
2823 match</emphasis> our pattern is <application>adv</application>, together with
2824 the forward slashes. What comes after the <quote>adv</quote> string is the
2829 Remember the <quote>?</quote> means the preceding expression (either a
2830 literal character or anything grouped with <quote>(...)</quote> in this case)
2831 can exist or not, since this means either zero or one match. So
2832 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
2833 individual sub-expressions: <quote>(er)</quote>,
2834 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
2835 means <quote>or</quote>. We have two of those. For instance,
2836 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
2837 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
2838 attempt at matching as many variations of <quote>advertisement</quote>, and
2839 similar, as possible. So this would expand to match just <quote>adv</quote>,
2840 or <quote>advert</quote>, or <quote>adverts</quote>, or
2841 <quote>advertising</quote>, or <quote>advertisement</quote>, or
2842 <quote>advertisements</quote>. You get the idea. But it would not match
2843 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
2844 changing our regular expression to:
2845 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
2850 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
2851 another path statement with forward slashes. Anything in the square brackets
2852 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
2853 shorthand expression to mean any digit one through nine. It is the same as
2854 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
2855 means one or more of the preceding expression must be included. The preceding
2856 expression here is what is in the square brackets -- in this case, any digit
2857 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
2858 This includes a <quote>|</quote>, so this needs to match the expression on
2859 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
2860 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
2861 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
2862 can be matched once or not at all. So we are building an expression here to
2863 match image GIF or JPEG type image file. It must include the literal
2864 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
2865 (which is now a literal, and not a special character, since it is escaped
2866 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
2867 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
2868 include: <quote>//advert1.jpg</quote>,
2869 <quote>/nasty/ads/advert1234.gif</quote>,
2870 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
2871 <quote>advert1.gif</quote> (no leading slash), or
2872 <quote>/adverts232.jpg</quote> (the expression does not include an
2873 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
2874 in the expression anywhere).
2878 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
2879 a substitution. <quote>MicroSuck</quote> will replace any occurence of
2880 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
2881 means ignore case. The <quote>(?!.com)</quote> means
2882 the match should fail if <quote>microsoft</quote> is followed by
2883 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
2884 modifier. In case this is a hyperlink, we don't want to break it ;-).
2888 We are barely scratching the surface of regular expressions here so that you
2889 can understand the default <application>Junkbuster</application>
2890 configuration files, and maybe use this knowledge to customize your own
2891 installation. There is much, much more that can be done with regular
2892 expressions. Now that you know enough to get started, you can learn more on
2897 More reading on Perl Compatible Regular expressions:
2898 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
2907 This program is free software; you can redistribute it
2908 and/or modify it under the terms of the GNU General
2909 Public License as published by the Free Software
2910 Foundation; either version 2 of the License, or (at
2911 your option) any later version.
2913 This program is distributed in the hope that it will
2914 be useful, but WITHOUT ANY WARRANTY; without even the
2915 implied warranty of MERCHANTABILITY or FITNESS FOR A
2916 PARTICULAR PURPOSE. See the GNU General Public
2917 License for more details.
2919 The GNU General Public License should be included with
2920 this file. If not, you can view it at
2921 http://www.gnu.org/copyleft/gpl.html
2922 or write to the Free Software Foundation, Inc., 59
2923 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2925 $Log: user-manual.sgml,v $
2927 Revision 1.9 2001/09/27 23:50:29 hal9
2928 A few changes. A short section on regular expression in appendix.
2930 Revision 1.8 2001/09/25 00:34:59 hal9
2931 Some additions, and re-arranging.
2933 Revision 1.7 2001/09/24 14:31:36 hal9
2936 Revision 1.6 2001/09/24 14:10:32 hal9
2937 Including David's OS/2 installation instructions.
2939 Revision 1.2 2001/09/13 15:27:40 swa
2942 Revision 1.1 2001/09/12 15:36:41 swa
2943 source files for junkbuster documentation
2945 Revision 1.3 2001/09/10 17:43:59 swa
2946 first proposal of a structure.
2948 Revision 1.2 2001/06/13 14:28:31 swa
2949 docs should have an author.
2951 Revision 1.1 2001/06/13 14:20:37 swa
2952 first import of project's documentation for the webserver.
projects / privoxy.git / blob