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.10 2001/09/28 02:18:12 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.10 2001/09/28 02:18:12 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.
147 <!-- ~~~~~ New section ~~~~~ -->
149 <title>New Features</title>
151 In addition to <application>Junkbuster's</application> traditional features
152 of ad and banner blocking and cookie management, this is a list of new
153 features currently under development:
161 Modularized configuration that will allow for system wide settings, and
162 individual user settings.
168 A web based GUI configuration utility.
174 Blocking of annoying pop-up browser windows (previously available as a
181 Support for HTTP 1.1.
187 Support for Perl Compatible Regular Expressions in the configuration files, and
188 generally a more sophisticated configuration syntax.
194 Web page content filtering.
205 <!-- ~ End section ~ -->
208 <!-- ~~~~~ New section ~~~~~ -->
209 <sect1 id="installation"><title>Installation</title>
211 <application>Junkbuster</application> is available as raw source code, or
212 pre-compiled binaries. See the <ulink
213 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
214 for current releases. <application>Junkbuster</application> is also available
216 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
217 This is the recommended approach at this time. But please be aware that CVS
218 is constantly changing, and it may break in mysterious ways.
221 <!-- ~~~~~ New section ~~~~~ -->
222 <sect2 id="installation-source"><title>Source</title>
224 For gzipped tar archives, unpack the source:
229 tar zxvf ijb_source_2.9*
235 For retrieving the current CVS sources, you'll need the CVS
236 package installed first. To download CVS source:
241 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
242 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
248 This will create a directory named <filename>current/</filename>, which will
249 contain the source tree.
253 Then, in either case, to build from source:
266 For Redhat and SuSE Linux RPM packages, see below.
272 <!-- ~~~~~ New section ~~~~~ -->
273 <sect2 id="installation-rh"><title>Red Hat</title>
275 To build Redhat RPM packages, install source as above. Then:
286 This will create both binary and src RPMs in the usual places. Example:
290 /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
293 /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm
297 To install, of course:
302 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
307 This will place the <application>Junkbuster</application> configuration
308 files in <filename>/etc/junkbuster/</filename>, and log files in
309 <filename>/var/log/junkbuster/</filename>.
314 <!-- ~~~~~ New section ~~~~~ -->
315 <sect2 id="installation-suse"><title>SuSE</title>
317 To build SuSE RPM packages, install source as above. Then:
328 This will create both binary and src RPMs in the usual places. Example:
332 /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
335 /usr/src/suse/SRPMS/junkbuster-2.9.8-1.src.rpm
339 To install, of course:
344 rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
349 This will place the <application>Junkbuster</application> configuration
350 files in <filename>/etc/junkbuster/</filename>, and log files in
351 <filename>/var/log/junkbuster/</filename>.
357 <!-- ~~~~~ New section ~~~~~ -->
358 <sect2 id="installation-os2"><title>OS/2</title>
365 The OS/2 version of <application>Junkbuster</application> requires the EMX
366 runtime library to be installed. The EMX runtime library is available on
367 the hobbes OS/2 archive, among many other locations:
368 <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>
372 <application>Junkbuster</application> is packaged in a WarpIN self-
373 installing archive. The self-installing program will be named depending
374 on the release version, something like:
375 <filename>ijbos123.exe</filename>. In order to install it, simply run
376 this executable or double-click on its icon and follow the WarpIN
377 installation panels. A shadow of the <application>Junkbuster</application>
378 executable will be placed in your startup folder so it will start
379 automatically whenever OS/2 starts.
383 The directory you choose to install <application>Junkbuster</application>
384 into will contain all of the configuration files.
388 If you would like to build binary images on OS/2 yourself, you will need
389 a working EMX/GCC environment, plus several Unix-like tools. The Hobbes
390 OS/2 archive is a good place to start when building such an environment.
391 A set of Unix-like tools named gnupack is located here:
392 <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>
395 Once you have the source code unpacked as above, you can build the binaries
396 from the <filename>current/</filename> directory:
410 <!-- ~~~~~ New section ~~~~~ -->
411 <sect2 id="installation-win"><title>Windows</title>
412 <para>I need help on this. Not a clue here. Also for
413 configuration section below.
417 <!-- ~~~~~ New section ~~~~~ -->
418 <sect2 id="installation-other"><title>Other</title>
420 Some quick notes on other Operating Systems.
424 For FreeBSD (and other *BSDs?), the build will need <command>gmake</command>
425 instead of the included <command>make</command>. <command>gmake</command> is
426 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
427 The rest should be the same as above for Linux/Unix.
434 <!-- ~ End section ~ -->
437 <!-- ~~~~~ New section ~~~~~ -->
438 <sect1 id="configuration"><title>Junkbuster Configuration</title>
440 For Unix, *BSD and Linux, all configuraton files are located in
441 <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
442 these are all in the same directory as the
443 <application>Junkbuster</application> executable. The name and number of
444 configuration files has changed from previous versions, and is subject to
445 change as development progresses.
449 The installed defaults provide a reasonable starting point. For the
450 time being, there are only three default configuration files (this will
459 The main configuration file is named <filename>config</filename>
460 on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
467 The <filename>actionsfile</filename> file is used to define various
468 actions relating to images, banners, pop-ups, banners and cookies.
474 The <filename>re_filterfile</filename> file can be used to rewrite the raw
475 page content, including text as well as embedded HTML and JavaScript.
483 <filename>actionsfile</filename> and <filename>re_filterfile</filename>
484 can use Perl style regular expressions for maximum flexibility. All files use
485 the <quote><literal>#</literal></quote> character to denote a comment. Such
486 lines are not processed by <application>Junkbuster</application>. After
487 making any changes, restart <application>Junkbuster</application> in order
488 for the changes to take effect.
492 <!-- ~~~~~ New section ~~~~~ -->
495 <title>The Main Configuration File</title>
497 Again, the main configuration file is named <filename>config</filename> on
498 Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
499 Configuration lines consist of an initial keyword followed by a list of
500 values, all separated by whitespace (any number of spaces or tabs). For
508 <emphasis>blockfile blocklist.ini</emphasis>
515 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
519 The <quote><literal>#</literal></quote> indicates a comment. Any part of a
520 line following a <quote><literal>#</literal></quote> is ignored, except if
521 the <quote><literal>#</literal></quote> is preceded by a
522 <quote><literal>\</literal></quote>.
526 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
527 existing configuration line, you can make it a comment and it will be treated
528 as if it weren't there. This is called <quote>commenting out</quote> an
529 option and can be useful to turn off features: If you comment out the
530 <quote>logfile</quote> line, <application>junkbuster</application> will not
531 log to a file at all. Watch for the <quote>default:</quote> section in each
532 explanation to see what happens if the option is left unset (or commented
537 Long lines can be continued on the next line by using a
538 <quote><literal>\</literal></quote> as the very last character.
542 There are various aspects of <application>Junkbuster</application> behavior
543 that can be adjusted.
547 <!-- ~~~~~ New section ~~~~~ -->
550 <title>Defining Other Configuration Files</title>
553 <application>Junkbuster</application> can use a number of other files to tell it
554 what ads to block, what cookies to accept, etc. This section of the
555 configuration file tells <application>Junkbuster</application> where to find
556 all those other files.
560 On <application>Windows</application>, <application>Junkbuster</application>
561 looks for these files in the same directory as the executable. On Unix and
562 OS/2, <application>Junkbuster</application> looks for these files in the current
563 working directory. In either case, an absolute path name can be used to
568 When development goes modular and multiuser, the blocker, filter, and
569 per-user config will be stored in subdirectories of <quote>confdir</quote>.
570 For now, only <filename>confdir/templates</filename> is used for storing HTML
571 templates for CGI results.
575 The location of the configuration files:
582 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
589 The directory where all logging (i.e. <filename>logfile</filename> and
590 <filename>jarfile</filename>) takes place. No trailing
591 <quote><literal>/</literal></quote>, please:
598 <emphasis>logdir /var/log/junkbuster</emphasis>
605 Note that all file specifications below are relative to
606 the above two directories!
610 The <quote>actionsfile</quote> contains patterns to specify the actions to
611 apply to requests for each site. Default: Cookies to and from all
612 destinations are filtered. Popups are disabled for all sites. All sites are
613 filtered if re_filterfile specified. No sites are blocked. An empty image is
614 displayed for filtered ads and other images (formerly
615 <quote>tinygif</quote>). The syntax of this file is explained in detail
616 <link linkend="actionsfile">below</link>.
623 <emphasis>actionsfile actionsfile</emphasis>
630 The <quote>re_filterfile</quote> file contains content modification rules.
631 These rules permit powerful changes on the content of Web pages, e.g., you
632 could disable your favourite JavaScript annoyances, rewrite the actual
633 content, or just have some fun replacing <quote>Microsoft</quote> with
634 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
635 content modification, or whatever the developers are playing with :-/
642 <emphasis>re_filterfile re_filterfile</emphasis>
649 The logfile is where all logging and error messages are written. The logfile
650 can be useful for tracking down a problem with
651 <application>Junkbuster</application> (e.g., it's not blocking an ad you
652 think it should block) but in most cases you probably will never look at it.
656 Your logfile will grow indefinitely, and you will probably want to
657 periodically remove it. On Unix systems, you can do this with a cron job
658 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
659 script has been included.
663 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
664 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
665 the effect that cron.daily will automatically archive, gzip, and empty the
666 log, when it exceeds 1M size.
670 Default: Log to the a file named <filename>logfile</filename>.
671 Comment out to disable logging.
678 <emphasis>logfile logfile</emphasis>
685 The <quote>jarfile</quote> defines where
686 <application>Junkbuster</application> stores the cookies it intercepts. Note
687 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
688 Don't store intercepted cookies.
695 <emphasis>#jarfile jarfile</emphasis>
702 If you specify a <quote>trustfile</quote>,
703 <application>Junkbuster</application> will only allow access to sites that
704 are named in the trustfile. You can also mark sites as trusted referrers,
705 with the effect that access to untrusted sites will be granted, if a link
706 from a trusted referrer was used. The link target will then be added to the
707 <quote>trustfile</quote>. This is a very restrictive feature that typical
708 users most propably want to leave disabled. Default: Disabled, don't use the
716 <emphasis>#trustfile trust</emphasis>
723 If you use the trust mechanism, it is a good idea to write up some online
724 documentation about your blocking policy and to specify the URL(s) here. They
725 will appear on the page that your users receive when they try to access
726 untrusted content. Use multiple times for multiple URLs. Default: Don't
727 display links on the <quote>untrusted</quote> info page.
734 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
735 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
743 <!-- ~ End section ~ -->
747 <!-- ~~~~~ New section ~~~~~ -->
750 <title>Other Configuration Options</title>
753 This part of the configuration file contains options that control how
754 <application>Junkbuster</application> operates.
758 <quote>Admin-address</quote> should be set to the email address of the proxy
759 administrator. It is used in many of the proxy-generated pages. Default:
767 <emphasis>#admin-address fill@me.in.please</emphasis>
774 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
775 about this <application>Junkbuster</application> installation, it's
776 configuration and policies. It is used in many of the proxy-generated pages
777 and its use is highly recommended in multi-user installations, since your
778 users will want to know why certain content is blocked or modified. Default:
779 Don't show a link to online documentation.
786 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
793 <quote>Listen-address</quote> specifies the address and port where
794 <application>Junkbuster</application> will listen for connections from your
795 Web browser. The default is to listen on the localhost port 8000, and
796 this is suitable for most users. (In your web browser, under proxy
797 configuration, list the proxy server as <quote>localhost</quote> and the
798 port as <quote>8000</quote>).
802 If you already have another service running on port 8000, or if you want to
803 serve requests from other machines (e.g. on your local network) as well, you
804 will need to override the default. The syntax is
805 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
806 out the IP adress, <application>junkbuster</application> will bind to all
807 interfaces (addresses) on your machine and may become reachable from the
808 internet. In that case, consider using access control lists (acl's) (see
809 <quote>aclfile</quote> above).
813 For example, suppose you are running <application>Junkbuster</application> on
814 a machine which has the address 192.168.0.1 on your local private network
815 (192.168.0.0) and has another outside connection with a different address.
816 You want it to serve requests from inside only:
823 <emphasis>listen-address 192.168.0.1:8000</emphasis>
830 If you want it to listen on all addresses (including the outside
838 <emphasis>listen-address :8000</emphasis>
845 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
846 you will need to point your browser(s) to the address and port that you have
847 configured here. Default: localhost:8000 (127.0.0.1:8000).
851 The debug option sets the level of debugging information to log in the
852 logfile (and to the console in the Windows version). A debug level of 1 is
853 informative because it will show you each request as it happens. Higher
854 levels of debug are probably only of interest to developers.
861 debug 1 # GPC = show each GET/POST/CONNECT request
862 debug 2 # CONN = show each connection status
863 debug 4 # IO = show I/O status
864 debug 8 # HDR = show header parsing
865 debug 16 # LOG = log all data into the logfile
866 debug 32 # FRC = debug force feature
867 debug 64 # REF = debug regular expression filter
868 debug 128 # = debug fast redirects
869 debug 256 # = debug GIF deanimation
870 debug 512 # CLF = Common Log Format
871 debug 1024 # = debug kill popups
872 debug 4096 # INFO = Startup banner and warnings.
873 debug 8192 # ERROR = Non-fatal errors
880 It is <emphasis>highly recommended</emphasis> that you enable ERROR
881 reporting (debug 8192), at least until the next stable release.
885 The reporting of FATAL errors (i.e. ones which crash
886 <application>JunkBuster</application>) is always on and cannot be disabled.
890 If you want to use CLF (Common Log Format), you should set <quote>debug
891 512</quote> ONLY, do not enable anything else.
895 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
903 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
917 <emphasis>debug 1 # URLs</emphasis>
918 <emphasis>debug 4096 # Info</emphasis>
919 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
926 <application>Junkbuster</application> normally uses
927 <quote>multi-threading</quote>, a software technique that permits it to
928 handle many different requests simultaneously. In some cases you may wish to
929 disable this -- particularly if you're trying to debug a problem. The
930 <quote>single-threaded</quote> option forces
931 <application>Junkbuster</application> to handle requests sequentially.
932 Default: Multi-threaded mode.
939 <emphasis>#single-threaded</emphasis>
946 <quote>toggle</quote> allows you to temporarily disable all
947 <application>Junkbuster's</application> filtering. Just set <quote>toggle
952 The Windows version of <application>Junkbuster</application> puts an icon in
953 the system tray, which allows you to change this option without having to
954 edit this file. If you right-click on that icon (or select the
955 <quote>Options</quote> menu), one choice is <quote>Enable</quote>. Clicking
956 on enable toggles <application>Junkbuster</application> on and off. This is
957 useful if you want to temporarily disable
958 <application>Junkbuster</application>, e.g., to access a site that requires
959 cookies which you normally have blocked.
963 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
964 normally, <quote>toggle 0</quote> means that
965 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
973 <emphasis>toggle 1</emphasis>
981 <!-- ~ End section ~ -->
984 <!-- ~~~~~ New section ~~~~~ -->
987 <title>Access Control List (ACL)</title>
989 Access controls are included at the request of some ISPs and systems
990 administrators, and are not usually needed by individual users. Please note
991 the warnings in the FAQ that this proxy is not intended to be a substitute
992 for a firewall or to encourage anyone to defer addressing basic security
997 If no access settings are specified, the proxy talks to anyone that
998 connects. If any access settings file are specified, then the proxy
999 talks only to IP addresses permitted somewhere in this file and not
1000 denied later in this file.
1004 Summary -- if using an ACL:
1009 Client must have permission to receive service.
1014 LAST match in ACL wins.
1019 Default behavior is to deny service.
1024 The syntax for an entry in the Access Control List is:
1031 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1038 Where the individual fields are:
1045 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1047 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1048 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1050 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1051 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1059 The field separator (FS) is whitespace (space or tab).
1063 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1064 forwarder (see below) or a gateway for a particular destination URL, the
1065 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1066 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1067 target. This is necessary because it may be impossible for the local
1068 <application>Junkbuster</application> to determine the address of the
1069 ultimate target (that's often what gateways are used for).
1073 Here are a few examples to show how the ACL features work:
1077 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1078 <emphasis>ALL</emphasis> destination addresses are OK:
1085 <emphasis>permit-access localhost</emphasis>
1092 A silly example to illustrate permitting any host on the class-C subnet with
1093 <application>Junkbuster</application> to go anywhere:
1100 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1107 Except deny one particular IP address from using it at all:
1114 <emphasis>deny-access ident.junkbusters.com</emphasis>
1121 You can also specify an explicit network address and subnet mask.
1122 Explicit addresses do not have to be resolved to be used.
1129 <emphasis>permit-access 207.153.200.0/24</emphasis>
1136 A subnet mask of 0 matches anything, so the next line permits everyone.
1143 <emphasis>permit-access 0.0.0.0/0</emphasis>
1150 Note, you <emphasis>cannot</emphasis> say:
1157 <emphasis>permit-access .org</emphasis>
1164 to allow all *.org domains. Every IP address listed must resolve fully.
1168 An ISP may want to provide a <application>Junkbuster</application> that is
1169 accessible by <quote>the world</quote> and yet restrict use of some of their
1170 private content to hosts on its internal network (i.e. its own subscribers).
1171 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1172 bit netmask). This is how they could do it:
1179 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1180 # with the following exceptions:
1182 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1183 # sites on the ISP's network
1185 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1188 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1196 Note that if some hostnames are listed with multiple IP addresses,
1197 the primary value returned by DNS (via gethostbyname()) is used. Default:
1198 Anyone can access the proxy.
1203 <!-- ~ End section ~ -->
1206 <!-- ~~~~~ New section ~~~~~ -->
1209 <title>Forwarding</title>
1212 This feature allows routing of HTTP requests via multiple proxies.
1213 It can be used to better protect privacy and confidentiality when
1214 accessing specific domains by routing requests to those domains
1215 to a special purpose filtering proxy such as lpwa.com.
1219 It can also be used in an environment with multiple networks to route
1220 requests via multiple gateways allowing transparent access to multiple
1221 networks without having to modify browser configurations.
1225 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1226 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1227 hostname using DNS on the SOCKS server, not our local DNS client.
1231 The syntax of each line is:
1238 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1239 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1240 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1247 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1248 HTTP proxy but are made directly to the web servers.
1252 Lines are checked in sequence, and the last match wins.
1256 There is an implicit line equivalent to the following, which specifies that
1257 anything not finding a match on the list is to go out without forwarding
1258 or gateway protocol, like so:
1265 <emphasis>forward .* . </emphasis># implicit
1272 In the following common configuration, everything goes to Lucent's LPWA,
1273 except SSL on port 443 (which it doesn't handle):
1280 <emphasis>forward .* lpwa.com:8000</emphasis>
1281 <emphasis>forward :443 .</emphasis>
1288 See the FAQ for instructions on how to automate the login procedure for LPWA.
1289 Some users have reported difficulties related to LPWA's use of
1290 <quote>.</quote> as the last element of the domain, and have said that this
1291 can be fixed with this:
1298 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1305 (NOTE: the syntax for specifiying target_domain has changed since the
1306 previous paragraph was written -- it will not work now. More information
1311 In this fictitious example, everything goes via an ISP's caching proxy,
1312 except requests to that ISP:
1319 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1320 <emphasis>forward myisp.net .</emphasis>
1327 For the @home network, we're told the forwarding configuration is this:
1335 <emphasis>forward .* proxy:8080</emphasis>
1342 Also, we're told they insist on getting cookies and JavaScript, so you need
1343 to add home.com to the cookie file. We consider JavaScript a security risk.
1344 Java need not be enabled.
1348 In this example direct connections are made to all <quote>internal</quote>
1349 domains, but everything else goes through Lucent's LPWA by way of the
1350 company's SOCKS gateway to the Internet.
1357 <emphasis>forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1358 <emphasis>forward my_company.com .</emphasis>
1365 This is how you could set up a site that always uses SOCKS but no forwarders:
1372 <emphasis>forward_socks4a .* . firewall.my_company.com:1080</emphasis>
1379 An advanced example for network administrators:
1383 If you have links to multiple ISPs that provide various special content to
1384 their subscribers, you can configure forwarding to pass requests to the
1385 specific host that's connected to that ISP so that everybody can see all
1386 of the content on all of the ISPs.
1390 This is a bit tricky, but here's an example:
1395 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1396 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1397 forwarding like this:
1404 <emphasis>forward .* .</emphasis>
1405 <emphasis>forward isp-b.com host-b:8000</emphasis>
1412 host-b can run a <application>Junkbuster</application> proxy with forwarding
1420 <emphasis>forward .* .</emphasis>
1421 <emphasis>forward isp-a.com host-a:8000</emphasis>
1428 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1429 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1430 host-a or host-b and be able to browse the content on isp-a or isp-b.
1434 Here's another practical example, for University of Kent at
1435 Canterbury students with a network connection in their room, who
1436 need to use the University's Squid web cache.
1443 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1444 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1445 <emphasis>forward * . </emphasis> # Host with no domain specified
1446 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1447 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1448 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1449 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1456 If you intend to chain <application>Junkbuster</application> and
1457 <application>squid</application> locally, then chain as
1458 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1462 Your squid configuration could then look like this:
1469 # Define junkbuster as parent cache
1470 cache_peer 127.0.0.1 8000 parent 0 no-query
1472 # Define ACL for protocol FTP
1475 # Do not forward ACL FTP to junkbuster
1476 always_direct allow FTP
1478 # Do not forward ACL CONNECT (https) to junkbuster
1479 always_direct allow CONNECT
1481 # Forward the rest to junkbuster
1482 never_direct allow all
1490 <!-- ~ End section ~ -->
1493 <!-- ~~~~~ New section ~~~~~ -->
1496 <title>Windows GUI Options</title>
1498 Removed references to Win32. HB 09/23/01
1501 <application>Junkbuster</application> has a number of options specific to the
1502 Windows GUI interface:
1506 If <quote>activity-animation</quote> is set to 1, the
1507 <application>Junkbuster</application> icon will animate when
1508 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1515 <emphasis>activity-animation 1</emphasis>
1522 If <quote>log-messages</quote> is set to 1,
1523 <application>Junkbuster</application> will log messages to the console
1531 <emphasis>log-messages 1</emphasis>
1538 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1539 i.e. the amount of memory used for the log messages displayed in the
1540 console window, will be limited to <quote>log-max-lines</quote> (see below).
1544 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1545 eat up all your memory!
1552 <emphasis>log-buffer-size 1</emphasis>
1559 <application>log-max-lines</application> is the maximum number of lines held
1560 in the log buffer. See above.
1567 <emphasis>log-max-lines 200</emphasis>
1574 If <quote>log-highlight-messages</quote> is set to 1,
1575 <application>Junkbuster</application> will highlight portions of the log
1576 messages with a bold-faced font:
1583 <emphasis>log-highlight-messages 1</emphasis>
1590 The font used in the console window:
1597 <emphasis>log-font-name Comic Sans MS</emphasis>
1604 Font size used in the console window:
1611 <emphasis>log-font-size 8</emphasis>
1618 <quote>show-on-task-bar</quote> controls whether or not
1619 <application>Junkbuster</application> will appear as a button on the Task bar
1627 <emphasis>show-on-task-bar 0</emphasis>
1634 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1635 button will minimize <application>Junkbuster</application> instead of closing
1636 the program (close with the exit option on the File menu).
1643 <emphasis>close-button-minimizes 1</emphasis>
1650 The <quote>hide-console</quote> option is specific to the MS-Win console
1651 version of <application>JunkBuster</application>. If this option is used,
1652 <application>Junkbuster</application> will disconnect from and hide the
1669 <!-- ~ End section ~ -->
1672 <!-- ~~~~~ New section ~~~~~ -->
1673 <sect2 id="actionsfile">
1674 <title>The Actions File</title>
1677 The <quote>actionsfile</quote> is used to define what actions
1678 <application>Junkbuster</application> takes, and thus determines how images,
1679 cookies and various other aspects of HTTP content and transactions are
1680 handled. Images can be anything you want, including ads, banners, or just
1681 some obnoxious image that you would rather not see. Cookies can be accepted
1682 or rejected. The default file is in fact named <filename>actionsfile</filename>.
1686 To determine which actions apply to a request, the URL of the request is
1687 compared to all patterns in this file. Every time it matches, the list of
1688 applicable actions for the URL is incrementally updated. You can trace
1689 this process by visiting <ulink
1690 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1694 There are four types of lines in this file: comments (begin with a
1695 <quote>#</quote> character), actions, aliases and patterns, all of which are
1700 <!-- ~~~~~ New section ~~~~~ -->
1702 <title>URL Domain and Path Syntax</title>
1704 Generally, a pattern has the form <domain>/<path>, where both the
1705 <domain> and <path> part are optional. If you only specify a
1706 domain part, the <quote>/</quote> can be left out:
1710 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1711 <quote>www.example.com</quote>.
1715 <emphasis>www.example.com/</emphasis> - means exactly the same.
1719 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1720 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1724 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1729 <emphasis>index.html</emphasis> - matches nothing, since it would be
1730 interpreted as a domain name and there is no top-level domain called
1731 <quote>.html</quote>.
1735 The matching of the domain part offers some flexible options: if the
1736 domain starts or ends with a dot, it becomes unanchored at that end.
1741 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1742 <quote>.example.com</quote>.
1746 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1751 Additionally, there are wildcards that you can use in the domain names
1752 themselves. They work pretty similar to shell wildcards: <quote>*</quote>
1753 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1754 any single character. And you can define charachter classes in square
1755 brackets and they can be freely mixed:
1759 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1760 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1764 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1768 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1769 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1773 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1774 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1775 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1776 <quote>wwww.example.com</quote>.
1780 If <application>Junkbuster</application> was compiled with
1781 <quote>pcre</quote> support (default), Perl compatible regular expressions
1782 can be used. See the <filename>pcre/docs/</filename> direcory or <quote>man
1783 perlre</quote> (also available on <ulink
1784 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1785 for details. A brief discussion of regular expressions is in the
1786 <link linkend="regex">Appendix</link>. For instance:
1790 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1791 domain, with any path that includes <quote>advert</quote> followed
1792 immediately by one or more digits, then a <quote>.</quote> and ending in
1793 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1794 <quote>example.com/ads/advert2.jpg</quote>, and
1795 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1796 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1801 Please note that matching in the path is case
1802 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1803 sensitive at any point in the pattern by using the
1804 <quote>(?-i)</quote> switch:
1808 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1809 documents whose path starts with <quote>PaTtErN</quote> in
1810 <emphasis>exactly</emphasis> this capitalization.
1815 <!-- ~ End section ~ -->
1819 <!-- ~~~~~ New section ~~~~~ -->
1822 <title>Actions</title>
1824 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1825 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1826 action name in curly braces (e.g. {+some_action}), followed by a list of
1827 URLs to which the action applies. There are three classes of actions:
1835 Boolean (e.g. <quote>+/-block</quote>):
1841 <emphasis>{+name}</emphasis> # enable this action
1842 <emphasis>{-name}</emphasis> # disable this action
1852 Parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1858 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1859 <emphasis>{-name}</emphasis> # disable action
1868 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1874 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1875 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1876 <emphasis>{-name}</emphasis> # disable this action totally
1887 If nothing is specified in this file, no <quote>actions</quote> are taken.
1888 So in this case <application>JunkBuster</application> would just be a
1889 normal, non-blocking, non-anonymizing proxy. You must specifically
1890 enable the privacy and blocking features you need (although the
1891 provided default <filename>actionsfile</filename> file will
1892 give a good starting point).
1896 Later defined actions always over-ride earlier ones. For multi-valued
1897 actions, the actions are applied in the order they are specified.
1901 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
1909 Add the specified HTTP header, which is not checked for validity.
1910 You may specify this many times to specify many different headers:
1916 <emphasis>+add-header{Name: value}</emphasis>
1926 Block this URL totally.
1932 <emphasis>+block</emphasis>
1942 De-animate all animated GIF images, i.e. reduce them to their last frame.
1943 This will also shrink the images considerably (in bytes, not pixels!). If
1944 the option <quote>first</quote> is given, the first frame of the animation
1945 is used as the replacement. If <quote>last</quote> is given, the last frame
1946 of the animation is used instead, which propably makes more sense for most
1947 banner animations, but also has the risk of not showing the entire last
1948 frame (if it is only a delta to an earlier frame).
1954 <emphasis>+deanimate-gifs{last}</emphasis>
1955 <emphasis>+deanimate-gifs{first}</emphasis>
1964 Many sites, like yahoo.com, don't just link to other sites. Instead, they
1965 will link to some script on their own server, giving the destination as a
1966 parameter, which will then redirect you to the final target. URLs resulting
1967 from this scheme typically look like:
1968 http://some.place/some_script?http://some.where-else.
1971 Sometimes, there are even multiple consecutive redirects encoded in the
1972 URL. These redirections via scripts make your web browing more traceable,
1973 since the server from which you follow such a link can see where you go to.
1974 Apart from that, valuable bandwidth and time is wasted, while your browser
1975 ask the server for one redirect after the other. Plus, it feeds the
1979 The <quote>+fast-redirects</quote> option enables interception of these
1980 requests by <application>Junkbuster</application>, who will cut off all but
1981 the last valid URL in the request and send a local redirect back to your
1982 browser without contacting the remote site.
1988 <emphasis>+fast-redirects</emphasis>
1997 Filter the website through the re_filterfile:
2003 <emphasis>+filter{filename}</emphasis>
2012 Block any existing X-Forwarded-for header, and do not add a new one:
2018 <emphasis>+hide-forwarded</emphasis>
2027 If the browser sends a <quote>From:</quote> header containing your e-mail
2028 address, this either completely removes the header (<quote>block</quote>), or
2029 changes it to the specified e-mail address.
2035 <emphasis>+hide-from{block}</emphasis>
2036 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2045 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2046 can block it, forge a URL to the same server as the request (which is
2047 preferred because some sites will not send images otherwise) or set it to a
2048 constant string of your choice.
2054 <emphasis>+hide-referer{block}</emphasis>
2055 <emphasis>+hide-referer{forge}</emphasis>
2056 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2065 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2066 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2067 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2068 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2074 <emphasis>+hide-referrer{...}</emphasis>
2083 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2084 browser type. Warning! This breaks many web sites. Specify the
2085 user-agent value you want. Example, pretend to be using Netscape on
2092 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2099 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2105 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2110 (Don't change the version number from 1.0 - after all, why tell them?)
2117 <emphasis>+hide-user-agent{browser-type}</emphasis>
2127 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2128 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2129 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2135 <emphasis>+image</emphasis>
2144 Decides what to do with URLs that end up tagged with <quote>{+block
2145 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2146 send a HTML <quote>blocked</quote> page, usually resulting in a
2147 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2148 send a <quote>JunkBuster</quote> image.
2149 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2150 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2151 temporary redirect to the specified image. This has the advantage of the
2152 icon being being cached by the browser, which will speed up the display.
2158 <emphasis>+image-blocker{logo}</emphasis>
2159 <emphasis>+image-blocker{blank}</emphasis>
2160 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2169 Prevent the website from reading cookies:
2175 <emphasis>+no-cookies-read</emphasis>
2184 Prevent the website from setting cookies:
2190 <emphasis>+no-cookies-set</emphasis>
2199 Filter the website through a built-in filter to disable those obnoxious
2200 JavaScript pop-up windows via window.open(), etc. The two alternative
2201 spellings are equivalent.
2207 <emphasis>+no-popup</emphasis>
2208 <emphasis>+no-popups</emphasis>
2217 This action only applies if you are using a <filename>jarfile</filename>
2218 for saving cookies. It sends a cookie to every site stating that you do not
2219 accept any copyright on cookies sent to you, and asking them not to track
2220 you. Of course, this is a (relatively) unique header they could use to
2227 <emphasis>+vanilla-wafer</emphasis>
2236 This allows you to add an arbitrary cookie. It can be specified multiple
2237 times in order to add as many cookies as you like.
2243 <emphasis>+wafer{name=value}</emphasis>
2254 The meaning of any of the above is reversed by preceding the action with a
2255 <quote>-</quote>, in place of the <quote>+</quote>.
2263 Turn off cookies by default, then allow a few through for specified sites:
2270 # Turn off all cookies
2271 { +no-cookies-read }
2274 # Execeptions to the above, sites that need cookies
2275 { -no-cookies-read }
2283 # Alternative way of saying the same thing
2284 {-no-cookies-set -no-cookies-read}
2293 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2303 # Reverse it for these two sites, which don't work right without it.
2305 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2313 Turn on page filtering, with one exception for sourceforge:
2320 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2323 # But please don't re_filter code from sourceforge!
2325 .cvs.sourceforge.net
2332 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2333 Many of these use regular expressions that will expand to match multiple
2343 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2344 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2345 /.*/(ng)?adclient\.cgi
2346 /.*/(plain|live|rotate)[-_.]?ads?/
2347 /.*/(sponsor)s?[0-9]?/
2348 /.*/_?(plain|live)?ads?(-banners)?/
2350 /.*/ad(sdna_image|gifs?)/
2351 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2355 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2359 /.*/cgi-bin/centralad/getimage
2360 /.*/images/addver\.gif
2361 /.*/images/marketing/.*\.(gif|jpe?g)
2365 /.*/sponsors?[0-9]?/
2366 /.*/advert[0-9]+\.jpg
2373 /graphics/defaultAd/
2375 /image\.ng/transactionID
2376 /images/.*/.*_anim\.gif # alvin brattli
2377 /ip_img/.*\.(gif|jpe?g)
2381 /cgi-bin/nph-adclick.exe/
2382 /.*/Image/BannerAdvertising/
2384 /.*/adlib/server\.cgi
2393 <!-- ~ End section ~ -->
2396 <!-- ~~~~~ New section ~~~~~ -->
2398 <title>Aliases</title>
2400 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2401 as <quote>aliases</quote>, can be defined by combing other <quote>actions</quote>.
2402 These can in turn be invoked just like the built-in <quote>actions</quote>.
2403 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2404 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2405 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2406 <quote>-</quote>. Alias names are not case sensitive, and must be defined
2407 before they are used.
2411 Now let's define a few aliases:
2422 +no-cookies = +no-cookies-set +no-cookies-read
2423 -no-cookies = -no-cookies-set -no-cookies-read
2424 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2425 shop = -no-cookies -filter -fast-redirects
2426 +imageblock = +block +image
2428 #For people who don't like to type too much: ;-)
2431 c2 = -no-cookies-set +no-cookies-read
2432 c3 = +no-cookies-set -no-cookies-read
2433 #... etc. Customize to your heart's content.
2440 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2448 # These sites are very complex and require
2449 # minimal interference.
2451 .office.microsoft.com
2452 .windowsupdate.microsoft.com
2454 # Shopping sites - still want to block ads.
2457 .worldpay.com # for quietpc.com
2461 # These shops require pop-ups
2473 <!-- ~ End section ~ -->
2476 <!-- ~~~~~ New section ~~~~~ -->
2477 <sect2 id="filterfile">
2478 <title>The Filter File</title>
2480 The filter file defines what filtering of web pages
2481 <application>Junkbuster</application> does. The default filter file is
2482 <filename>re_filterfile</filename>, located in the config directory. In this
2483 file, <emphasis>any document content</emphasis>, whether viewable text or
2484 embedded non-visible content, can be changed.
2488 This file uses regular expressions to alter or remove any string in the
2489 target page. Some examples from the included default <filename>re_filterfile</filename>:
2493 Stop web pages from displaying annoying messages in the status bar by
2494 deleting such references:
2501 # The status bar is for displaying link targets, not pointless buzzwords.
2502 # Again, check it out on http://www.airport-cgn.de/.
2503 s/status='.*?';*//ig
2510 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2511 <quote>MicroSuck</quote>:
2518 s/microsoft(?!.com)/MicroSuck/ig
2525 Kill those auto-refresh tags:
2532 # Kill refresh tags. I like to refresh myself. Manually.
2533 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2535 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2536 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2546 <!-- ~~~~~ New section ~~~~~ -->
2547 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2549 Install package, then run and enjoy! Be sure your browser is set to use
2550 the proxy which is by default at localhost, port 8000. With
2551 <application>Netscape</application> (and <application>Mozilla</application>),
2552 this can be set under <literal>Edit -> Preferences -> Advanced ->
2553 Proxies -> HTTP Proxy</literal>. For <application>Internet
2554 Explorer</application>: <literal>Internet Properties -> Connections ->
2555 LAN Setting</literal>. Then, check <quote>Use Proxy</quote> and fill in the
2556 appropriate info (Address: localhost, Port: 8000).
2560 The included default configuration files should give a reasonable starting
2561 point, though may be somewhat aggressive in blocking junk. You will probably
2562 want to keep an eye out for sites that require cookies, and add these to
2563 <filename>actionsfile</filename> as needed. By default, most of these will
2564 be blocked until you add them to the configuration. If you want the browser
2565 to handle this, you will need to edit <filename>actionsfile</filename> and
2566 disable this feature. If you use more than one browser, it would make more
2567 sense to let <application>Junkbuster</application> handle this. In which
2568 case, the browser(s) should be set to accept all cookies.
2572 If you encounter problems, please verify it is a
2573 <application>Junkbuster</application> bug, by disabling
2574 <application>Junkbuster</application>, and then trying the same page.
2575 Before reporting it as a bug, see if there is not a configuration
2576 option that is enabled that is causing the page not to load. You can
2577 then add an exception for that page or site. If a bug, please report it to
2578 the developers (see below).
2584 <!-- ~~~~~ New section ~~~~~ -->
2585 <sect1 id="contact"><title>Contact the Developers</title>
2588 To be filled. mention the support forums as the primary channel of
2589 communication (bugs, feature requests, etc.)
2591 Feature requests and other questions should be posted to the <ulink
2592 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
2593 request page</ulink> at SourceForge. There is also an archive there.
2597 Anyone interested in actively participating in development and related
2598 discussions can join the appropriate mailing list
2599 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
2600 Archives are available here too.
2604 Please report bugs, using the form at
2605 <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
2606 Please try to verify that it is a <application>Junkbuster</application> bug,
2607 and not a browser or site bug first. Also, check to make sure this is not
2608 already a known bug.
2614 <!-- ~~~~~ New section ~~~~~ -->
2615 <sect1 id="copyright"><title>Copyright and History</title>
2618 <title>License</title>
2620 <application>Internet Junkbuster</application> is free software; you can
2621 redistribute it and/or modify it under the terms of the GNU General Public
2622 License as published by the Free Software Foundation; either version 2 of the
2623 License, or (at your option) any later version.
2627 This program is distributed in the hope that it will be useful, but WITHOUT
2628 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2629 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2630 details, which is available from <ulink
2631 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
2632 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2637 <!-- ~ End section ~ -->
2640 <!-- ~~~~~ New section ~~~~~ -->
2643 <title>History</title>
2645 <application>Junkbuster</application> was originally written by Anonymous
2647 url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
2648 Corporation</ulink>, and was released as free open-source software under the
2649 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
2650 Waldherr</ulink> made many improvements, and started the <ulink
2651 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
2652 rekindle development. The last stable release was v2.0.2, which has now
2660 <!-- ~~~~~ New section ~~~~~ -->
2661 <sect1 id="seealso"><title>See also</title>
2662 <para>To be filled. What should go here :/
2668 <!-- ~~~~~ New section ~~~~~ -->
2669 <sect1 id="appendix"><title>Appendix</title>
2672 <!-- ~~~~~ New section ~~~~~ -->
2674 <title>Regular Expressions</title>
2676 <application>Junkbuster</application> can use <quote>regular expressions</quote>
2677 in various config files. Assuming support for <quote>pcre</quote> (Perl
2678 Compatible Regular Expressions) is compiled in, which is the default. Such
2679 configuration directives do not require regular expressions, but they can be
2680 used to increase flexibility by matching a pattern with wildcards against
2685 If you are reading this, you probably don't understand what <quote>regular
2686 expressions</quote> are, or what they can do. So this will be a very brief
2687 introduction only. A full explanation would require a book ;-)
2691 <quote>Regular expressions</quote> is a way of matching one character
2692 expression against another to see if it matches or not. One of the
2693 <quote>expressions</quote> is a literal string of readable characters
2694 (letter, numbers, etc), and the other is a complex string of literal
2695 characters combined with wildcards, and other special characters, called
2696 metacharacters. The <quote>metacharacters</quote> have special meanings and
2697 are used to build the complex pattern to be matched against. Perl Compatible
2698 Regular Expressions is an enhanced form of the regular expression language
2699 with backward compatibility.
2703 To make a simple analogy, we do something similar when we use wildcard
2704 characters when listing files with the <command>dir</command> command in DOS.
2705 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
2706 character here is the asterik which matches any and all characters. We can be
2707 more specific and use <literal>?</literal> to match just individual
2708 characters. So <quote>dir file?.text</quote> would match
2709 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
2710 matching, using a similar technique to <quote>regular expressions</quote>!
2714 Regular expressions do essentially the same thing, but are much, much more
2715 powerful. There are many more <quote>special characters</quote> and ways of
2716 building complex patterns however. Let's look at a few of the common ones,
2717 and then some examples:
2722 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
2723 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
2729 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
2736 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
2743 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
2750 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
2751 the following character should be taken literally. This is used where one of the
2752 special characters (e.g. <quote>.</quote>) needs to be taken literally and
2753 not as a special metacharacter.
2759 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
2760 any of the enclosed characters are encountered.
2766 <emphasis>()</emphasis> - Pararentheses are used to group a sub-expression,
2767 or multiple sub-expressions.
2773 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
2774 <quote>or</quote> conditional statement. A match is successful if the
2775 sub-expression on either side of <quote>|</quote> matches.
2781 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
2782 <quote>string1</quote> is replaced by <quote>string2</quote> in this
2788 These are just some of the ones you are likely to use when matching URLs with
2789 <application>Junkbuster</application>, and is a long way from a definitive
2790 list. This is enough to get us started with a few simple examples which may
2791 be more illuminating:
2795 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
2796 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
2797 denote any character, zero or more times. In other words, any string at all.
2798 So we start with a literal forward slash, then our regular expression pattern
2799 (<quote>.*</quote>) another literal forward slash, the string
2800 <quote>banners</quote>, another forward slash, and lastly another
2801 <quote>.*</quote>. We are building
2802 a directory path here. This will match any file with the path that has a
2803 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
2804 any characters, and this could conceivably be more forward slashes, so it
2805 might expand into a much longer looking path. For example, this could match:
2806 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
2807 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
2808 possible combinations, just so it has <quote>banners</quote> in the path
2813 A now something a little more complex:
2817 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
2818 We have several literal forward slashes again (<quote>/</quote>), so we are
2819 building another expression that is a file path statement. We have another
2820 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
2821 it matches our expression. The only true literal that <emphasis>must
2822 match</emphasis> our pattern is <application>adv</application>, together with
2823 the forward slashes. What comes after the <quote>adv</quote> string is the
2828 Remember the <quote>?</quote> means the preceding expression (either a
2829 literal character or anything grouped with <quote>(...)</quote> in this case)
2830 can exist or not, since this means either zero or one match. So
2831 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
2832 individual sub-expressions: <quote>(er)</quote>,
2833 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
2834 means <quote>or</quote>. We have two of those. For instance,
2835 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
2836 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
2837 attempt at matching as many variations of <quote>advertisement</quote>, and
2838 similar, as possible. So this would expand to match just <quote>adv</quote>,
2839 or <quote>advert</quote>, or <quote>adverts</quote>, or
2840 <quote>advertising</quote>, or <quote>advertisement</quote>, or
2841 <quote>advertisements</quote>. You get the idea. But it would not match
2842 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
2843 changing our regular expression to:
2844 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
2849 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
2850 another path statement with forward slashes. Anything in the square brackets
2851 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
2852 shorthand expression to mean any digit one through nine. It is the same as
2853 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
2854 means one or more of the preceding expression must be included. The preceding
2855 expression here is what is in the square brackets -- in this case, any digit
2856 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
2857 This includes a <quote>|</quote>, so this needs to match the expression on
2858 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
2859 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
2860 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
2861 can be matched once or not at all. So we are building an expression here to
2862 match image GIF or JPEG type image file. It must include the literal
2863 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
2864 (which is now a literal, and not a special character, since it is escaped
2865 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
2866 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
2867 include: <quote>//advert1.jpg</quote>,
2868 <quote>/nasty/ads/advert1234.gif</quote>,
2869 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
2870 <quote>advert1.gif</quote> (no leading slash), or
2871 <quote>/adverts232.jpg</quote> (the expression does not include an
2872 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
2873 in the expression anywhere).
2877 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
2878 a substitution. <quote>MicroSuck</quote> will replace any occurence of
2879 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
2880 means ignore case. The <quote>(?!.com)</quote> means
2881 the match should fail if <quote>microsoft</quote> is followed by
2882 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
2883 modifier. In case this is a hyperlink, we don't want to break it ;-).
2887 We are barely scratching the surface of regular expressions here so that you
2888 can understand the default <application>Junkbuster</application>
2889 configuration files, and maybe use this knowledge to customize your own
2890 installation. There is much, much more that can be done with regular
2891 expressions. Now that you know enough to get started, you can learn more on
2896 More reading on Perl Compatible Regular expressions:
2897 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
2906 This program is free software; you can redistribute it
2907 and/or modify it under the terms of the GNU General
2908 Public License as published by the Free Software
2909 Foundation; either version 2 of the License, or (at
2910 your option) any later version.
2912 This program is distributed in the hope that it will
2913 be useful, but WITHOUT ANY WARRANTY; without even the
2914 implied warranty of MERCHANTABILITY or FITNESS FOR A
2915 PARTICULAR PURPOSE. See the GNU General Public
2916 License for more details.
2918 The GNU General Public License should be included with
2919 this file. If not, you can view it at
2920 http://www.gnu.org/copyleft/gpl.html
2921 or write to the Free Software Foundation, Inc., 59
2922 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2924 $Log: user-manual.sgml,v $
2926 Revision 1.9 2001/09/27 23:50:29 hal9
2927 A few changes. A short section on regular expression in appendix.
2929 Revision 1.8 2001/09/25 00:34:59 hal9
2930 Some additions, and re-arranging.
2932 Revision 1.7 2001/09/24 14:31:36 hal9
2935 Revision 1.6 2001/09/24 14:10:32 hal9
2936 Including David's OS/2 installation instructions.
2938 Revision 1.2 2001/09/13 15:27:40 swa
2941 Revision 1.1 2001/09/12 15:36:41 swa
2942 source files for junkbuster documentation
2944 Revision 1.3 2001/09/10 17:43:59 swa
2945 first proposal of a structure.
2947 Revision 1.2 2001/06/13 14:28:31 swa
2948 docs should have an author.
2950 Revision 1.1 2001/06/13 14:20:37 swa
2951 first import of project's documentation for the webserver.
projects / privoxy.git / blob