1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
7 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
9 $Id: user-manual.sgml,v 1.32 2002/03/03 09:26:06 joergs Exp $
11 Written by and Copyright (C) 2001 the SourceForge
12 IJBSWA team. http://ijbswa.sourceforge.net
14 Based on the Internet Junkbuster originally written
15 by and Copyright (C) 1997 Anonymous Coders and
16 Junkbusters Corporation. http://www.junkbusters.com
20 Sat 03/02/02 04:53:47 PM
22 This should be ready for BETA release.
24 Hal Burgiss <hal@foobox.net>
29 <title>Junkbuster User Manual</title>
31 <pubdate>$Id: user-manual.sgml,v 1.32 2002/03/03 09:26:06 joergs Exp $</pubdate>
36 <orgname>By: Junkbuster Developers</orgname>
43 The user manual gives the users information on how to install and configure
44 <application>Internet Junkbuster</application>. <application>Internet
45 Junkbuster</application> is an application that provides privacy and
46 security to users of the World Wide Web.
49 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
53 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
60 <!-- ~~~~~ New section ~~~~~ -->
62 <sect1 id="introduction"><title>Introduction</title>
64 <application>Internet Junkbuster</application> is a web proxy with advanced
65 filtering capabilities for protecting privacy, filtering and modifying web
66 page content, managing cookies, controlling access, and removing ads,
67 banners, pop-ups and other obnoxious Internet Junk.
68 <application>Junkbuster</application> has a very flexible configuration and
69 can be customized to suit individual needs and tastes. <application>Internet
70 Junkbuster</application> has application for both stand-alone systems and
75 This documentation is included with the current BETA version of
76 <application>Internet Junkbuster</application> and mostly complete at this
77 point. The most up to date reference for the time being is still the comments
78 in the source files and in the individual configuration files. Development
79 of version 3.0 is currently nearing completion, and includes many significant
80 changes and enhancements over earlier versions. The target release date for
81 stable v3.0 is <quote>soon</quote> ;-)
85 Since this is a BETA version, not all new features are well tested. This
86 documentation may be slightly out of sync as a result. And there
87 <emphasis>may be</emphasis> bugs, though hopefully not many!
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 Integrated browser based configuration and control utility (<ulink
106 url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
113 Modularized configuration that will allow for system wide settings, and
114 individual user settings. (not implemented yet, probably a 3.1 feature)
120 Blocking of annoying pop-up browser windows.
126 HTTP/1.1 compliant (most, but not all 1.1 features are supported).
132 Support for Perl Compatible Regular Expressions in the configuration files, and
133 generally a more sophisticated and flexible configuration syntax over
146 Web page content filtering (removes banners based on size,
147 invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
154 Bypass many click-tracking scripts (avoids script redirection).
161 Multi-threaded (POSIX and native threads).
167 Auto-detection and re-reading of config file changes.
173 User-customizable HTML templates (e.g. 404 error page).
179 Improved cookie management features (e.g. session based cookies).
185 Builds from source on most UNIX-like systems. Packages available for: Linux
186 (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2.
193 In addition, the configuration is much more powerful and versatile over-all.
204 <!-- ~ End section ~ -->
207 <!-- ~~~~~ New section ~~~~~ -->
208 <sect1 id="installation"><title>Installation</title>
210 <application>Junkbuster</application> is available as raw source code, or
211 pre-compiled binaries. See the <ulink
212 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
213 for current release info. <application>Junkbuster</application> is also available
215 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
216 This is the recommended approach at this time. But please be aware that CVS
217 is constantly changing, and it may break in mysterious ways.
220 <!-- ~~~~~ New section ~~~~~ -->
221 <sect2 id="installation-source"><title>Source</title>
223 For gzipped tar archives, unpack the source:
228 tar xzvf ijb_source_* [.tgz or .tar.gz]
229 cd ijb_source_2.9.10_beta
234 For retrieving the current CVS sources, you'll need the CVS
235 package installed first. To download CVS source:
240 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
241 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
247 This will create a directory named <filename>current/</filename>, which will
248 contain the source tree.
252 Then, in either case, to build from tarball/CVS source:
257 ./configure (--help to see options)
258 make (the make from gnu, gmake for *BSD)
260 make -n install (to see where all the files will go)
261 make install (to really install)
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:
280 autoheader [suggested for CVS source]
281 autoconf [suggested for CVS source]
288 This will create both binary and src RPMs in the usual places. Example:
292 /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
295 /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
299 To install, of course:
304 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
309 This will place the <application>Junkbuster</application> configuration
310 files in <filename>/etc/junkbuster/</filename>, and log files in
311 <filename>/var/log/junkbuster/</filename>.
316 <!-- ~~~~~ New section ~~~~~ -->
317 <sect2 id="installation-suse"><title>SuSE</title>
319 To build SuSE RPM packages, install source as above. Then:
324 autoheader [suggested for CVS source]
325 autoconf [suggested for CVS source]
332 This will create both binary and src RPMs in the usual places. Example:
336 /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
339 /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
343 To install, of course:
348 rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
353 This will place the <application>Junkbuster</application> configuration
354 files in <filename>/etc/junkbuster/</filename>, and log files in
355 <filename>/var/log/junkbuster/</filename>.
361 <!-- ~~~~~ New section ~~~~~ -->
362 <sect2 id="installation-os2"><title>OS/2</title>
369 <application>Junkbuster</application> is packaged in a WarpIN self-
370 installing archive. The self-installing program will be named depending
371 on the release version, something like:
372 <filename>ijbos2_setup_1.2.3.exe</filename>. In order to install it, simply
373 run this executable or double-click on its icon and follow the WarpIN
374 installation panels. A shadow of the <application>Junkbuster</application>
375 executable will be placed in your startup folder so it will start
376 automatically whenever OS/2 starts.
380 The directory you choose to install <application>Junkbuster</application>
381 into will contain all of the configuration files.
385 If you would like to build binary images on OS/2 yourself, you will need
386 a few Unix-like tools: autoconf, autoheader and sh. These tools will be
387 used to create the required config.h file, which is not part of the
388 source distribution because it differs based on platform. You will also
390 The distribution has been created using IBM VisualAge compilers, but you
391 can use any compiler you like. GCC/EMX has the disadvantage of needing
392 to be single-threaded due to a limitation of EMX's implementation of the
393 select() socket call.
397 In addition to needing the source code distribution as outlined earlier,
398 you will want to extract the <filename>os2seutp</filename> directory from CVS:
400 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
401 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
403 This will create a directory named os2setup/, which will contain the
404 <filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
405 which is used to completely create the binary distribution. The sequence
406 of events for building the executable for yourself goes something like this:
413 nmake -f Makefile.vac
415 You will see this sequence laid out in <filename>os2build.cmd</filename>.
421 <!-- ~~~~~ New section ~~~~~ -->
422 <sect2 id="installation-win"><title>Windows</title>
423 <para>Click-click. (I need help on this. Not a clue here. Also for
424 configuration section below. HB.)
428 <!-- ~~~~~ New section ~~~~~ -->
429 <sect2 id="installation-other"><title>Other</title>
431 Some quick notes on other Operating Systems.
435 For FreeBSD (and other *BSDs?), the build will require <command>gmake</command>
436 instead of the included <command>make</command>. <command>gmake</command> is
437 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
438 The rest should be the same as above for Linux/Unix.
445 <!-- ~ End section ~ -->
448 <!-- ~~~~~ New section ~~~~~ -->
449 <sect1 id="configuration"><title>Junkbuster Configuration</title>
451 For Unix, *BSD and Linux, all configuration files are located in
452 <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
453 AmigaOS these are all in the same directory as the
454 <application>Junkbuster</application> executable. The name and number of
455 configuration files has changed from previous versions, and is subject to
456 change as development progresses.
460 The installed defaults provide a reasonable starting point, though possibly
461 aggressive by some standards. For the time being, there are only three
462 default configuration files (this will change in time):
470 The main configuration file is named <filename>config</filename>
471 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
478 The <filename>ijb.action</filename> file is used to define various
479 <quote>actions</quote> relating to images, banners, pop-ups, access
480 restrictions, banners and cookies. There is a CGI based editor for this
481 file that can be accessed via <ulink
482 url="http://i.j.b">http://i.j.b</ulink>. This is the easiest method of
483 configuring actions. (Other actions
484 files are included as well with differing levels of filtering
485 and blocking, e.g. <filename>ijb-basic.action</filename>.)
491 The <filename>re_filterfile</filename> file can be used to rewrite the raw
492 page content, including text as well as embedded HTML and JavaScript.
500 <filename>ijb.action</filename> and <filename>re_filterfile</filename>
501 can use Perl style regular expressions for maximum flexibility. All files use
502 the <quote><literal>#</literal></quote> character to denote a comment. Such
503 lines are not processed by <application>Junkbuster</application>. After
504 making any changes, there is no need to restart
505 <application>Junkbuster</application> in order for the changes to take
506 effect. <application>Junkbuster</application> should detect such changes
511 While under development, the configuration content is subject to change.
512 The below documentation may not be accurate by the time you read this.
513 Also, what constitutes a <quote>default</quote> setting, may change, so
514 please check all your configuration files on important issues.
517 <!-- ~~~~~ New section ~~~~~ -->
520 <title>The Main Configuration File</title>
522 Again, the main configuration file is named <filename>config</filename> on
523 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
524 Configuration lines consist of an initial keyword followed by a list of
525 values, all separated by whitespace (any number of spaces or tabs). For
533 <emphasis>blockfile blocklist.ini</emphasis>
540 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
544 A <quote><literal>#</literal></quote> indicates a comment. Any part of a
545 line following a <quote><literal>#</literal></quote> is ignored, except if
546 the <quote><literal>#</literal></quote> is preceded by a
547 <quote><literal>\</literal></quote>.
551 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
552 existing configuration line, you can make it a comment and it will be treated
553 as if it weren't there. This is called <quote>commenting out</quote> an
554 option and can be useful to turn off features: If you comment out the
555 <quote>logfile</quote> line, <application>junkbuster</application> will not
556 log to a file at all. Watch for the <quote>default:</quote> section in each
557 explanation to see what happens if the option is left unset (or commented
562 Long lines can be continued on the next line by using a
563 <quote><literal>\</literal></quote> as the very last character.
567 There are various aspects of <application>Junkbuster</application> behavior
572 <!-- ~~~~~ New section ~~~~~ -->
575 <title>Defining Other Configuration Files</title>
578 <application>Junkbuster</application> can use a number of other files to tell it
579 what ads to block, what cookies to accept, etc. This section of the
580 configuration file tells <application>Junkbuster</application> where to find
581 all those other files.
585 On <application>Windows</application> and <application>AmigaOS</application>,
586 <application>Junkbuster</application> looks for these files in the same
587 directory as the executable. On Unix and OS/2,
588 <application>Junkbuster</application> looks for these files in the current
589 working directory. In either case, an absolute path name can be used to
594 When development goes modular and multi-user, the blocker, filter, and
595 per-user config will be stored in subdirectories of <quote>confdir</quote>.
596 For now, only <filename>confdir/templates</filename> is used for storing HTML
597 templates for CGI results.
601 The location of the configuration files:
608 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
615 The directory where all logging (i.e. <filename>logfile</filename> and
616 <filename>jarfile</filename>) takes place. No trailing
617 <quote><literal>/</literal></quote>, please:
624 <emphasis>logdir /var/log/junkbuster</emphasis>
631 Note that all file specifications below are relative to
632 the above two directories!
636 The <quote>ijb.action</quote> file contains patterns to specify the actions to
637 apply to requests for each site. Default: Cookies to and from all
638 destinations are kept only during the current browser session (i.e. they
639 are not saved to disk). Pop-ups are disabled for all sites. All sites are
640 filtered if <quote>re_filterfile</quote> specified. No sites are blocked. An
641 empty image is displayed for filtered ads and other images (formerly
642 <quote>tinygif</quote>). The syntax of this file is explained in detail <link
643 linkend="actionsfile">below</link>.
650 <emphasis>actionsfile ijb.action</emphasis>
657 The <quote>re_filterfile</quote> file contains content modification rules.
658 These rules permit powerful changes on the content of Web pages, e.g., you
659 could disable your favorite JavaScript annoyances, rewrite the actual
660 content, or just have some fun replacing <quote>Microsoft</quote> with
661 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
662 content modification, or whatever the developers are playing with :-/
669 <emphasis>re_filterfile re_filterfile</emphasis>
676 The logfile is where all logging and error messages are written. The logfile
677 can be useful for tracking down a problem with
678 <application>Junkbuster</application> (e.g., it's not blocking an ad you
679 think it should block) but in most cases you probably will never look at it.
683 Your logfile will grow indefinitely, and you will probably want to
684 periodically remove it. On Unix systems, you can do this with a cron job
685 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
686 script has been included.
690 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
691 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
692 the effect that cron.daily will automatically archive, gzip, and empty the
693 log, when it exceeds 1M size.
697 Default: Log to the a file named <filename>logfile</filename>.
698 Comment out to disable logging.
705 <emphasis>logfile logfile</emphasis>
712 The <quote>jarfile</quote> defines where
713 <application>Junkbuster</application> stores the cookies it intercepts. Note
714 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
715 Don't store intercepted cookies.
722 <emphasis>#jarfile jarfile</emphasis>
729 If you specify a <quote>trustfile</quote>,
730 <application>Junkbuster</application> will only allow access to sites that
731 are named in the trustfile. You can also mark sites as trusted referrers,
732 with the effect that access to untrusted sites will be granted, if a link
733 from a trusted referrer was used. The link target will then be added to the
734 <quote>trustfile</quote>. This is a very restrictive feature that typical
735 users most probably want to leave disabled. Default: Disabled, don't use the
743 <emphasis>#trustfile trust</emphasis>
750 If you use the trust mechanism, it is a good idea to write up some on-line
751 documentation about your blocking policy and to specify the URL(s) here. They
752 will appear on the page that your users receive when they try to access
753 untrusted content. Use multiple times for multiple URLs. Default: Don't
754 display links on the <quote>untrusted</quote> info page.
761 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
762 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
770 <!-- ~ End section ~ -->
774 <!-- ~~~~~ New section ~~~~~ -->
777 <title>Other Configuration Options</title>
780 This part of the configuration file contains options that control how
781 <application>Junkbuster</application> operates.
785 <quote>Admin-address</quote> should be set to the email address of the proxy
786 administrator. It is used in many of the proxy-generated pages. Default:
794 <emphasis>#admin-address fill@me.in.please</emphasis>
801 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
802 about this <application>Junkbuster</application> installation, it's
803 configuration and policies. It is used in many of the proxy-generated pages
804 and its use is highly recommended in multi-user installations, since your
805 users will want to know why certain content is blocked or modified. Default:
806 Don't show a link to on-line documentation.
813 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
820 <quote>Listen-address</quote> specifies the address and port where
821 <application>Junkbuster</application> will listen for connections from your
822 Web browser. The default is to listen on the localhost port 8000, and
823 this is suitable for most users. (In your web browser, under proxy
824 configuration, list the proxy server as <quote>localhost</quote> and the
825 port as <quote>8000</quote>).
829 If you already have another service running on port 8000, or if you want to
830 serve requests from other machines (e.g. on your local network) as well, you
831 will need to override the default. The syntax is
832 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
833 out the IP address, <application>junkbuster</application> will bind to all
834 interfaces (addresses) on your machine and may become reachable from the
835 Internet. In that case, consider using access control lists (acl's) (see
836 <quote>aclfile</quote> above), or a firewall.
840 For example, suppose you are running <application>Junkbuster</application> on
841 a machine which has the address 192.168.0.1 on your local private network
842 (192.168.0.0) and has another outside connection with a different address.
843 You want it to serve requests from inside only:
850 <emphasis>listen-address 192.168.0.1:8000</emphasis>
857 If you want it to listen on all addresses (including the outside
865 <emphasis>listen-address :8000</emphasis>
872 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
873 you will need to point your browser(s) to the address and port that you have
874 configured here. Default: localhost:8000 (127.0.0.1:8000).
878 The debug option sets the level of debugging information to log in the
879 logfile (and to the console in the Windows version). A debug level of 1 is
880 informative because it will show you each request as it happens. Higher
881 levels of debug are probably only of interest to developers.
888 debug 1 # GPC = show each GET/POST/CONNECT request
889 debug 2 # CONN = show each connection status
890 debug 4 # IO = show I/O status
891 debug 8 # HDR = show header parsing
892 debug 16 # LOG = log all data into the logfile
893 debug 32 # FRC = debug force feature
894 debug 64 # REF = debug regular expression filter
895 debug 128 # = debug fast redirects
896 debug 256 # = debug GIF de-animation
897 debug 512 # CLF = Common Log Format
898 debug 1024 # = debug kill pop-ups
899 debug 4096 # INFO = Startup banner and warnings.
900 debug 8192 # ERROR = Non-fatal errors
907 It is <emphasis>highly recommended</emphasis> that you enable ERROR
908 reporting (debug 8192), at least until the next stable release.
912 The reporting of FATAL errors (i.e. ones which crash
913 <application>JunkBuster</application>) is always on and cannot be disabled.
917 If you want to use CLF (Common Log Format), you should set <quote>debug
918 512</quote> ONLY, do not enable anything else.
922 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
930 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
944 <emphasis>debug 1 # URLs</emphasis>
945 <emphasis>debug 4096 # Info</emphasis>
946 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
953 <application>Junkbuster</application> normally uses
954 <quote>multi-threading</quote>, a software technique that permits it to
955 handle many different requests simultaneously. In some cases you may wish to
956 disable this -- particularly if you're trying to debug a problem. The
957 <quote>single-threaded</quote> option forces
958 <application>Junkbuster</application> to handle requests sequentially.
959 Default: Multi-threaded mode.
966 <emphasis>#single-threaded</emphasis>
973 <quote>toggle</quote> allows you to temporarily disable all
974 <application>Junkbuster's</application> filtering. Just set <quote>toggle
979 The Windows version of <application>Junkbuster</application> puts an icon in
980 the system tray, which also allows you to change this option. If you
981 right-click on that icon (or select the <quote>Options</quote> menu), one
982 choice is <quote>Enable</quote>. Clicking on enable toggles
983 <application>Junkbuster</application> on and off. This is useful if you want
984 to temporarily disable <application>Junkbuster</application>, e.g., to access
985 a site that requires cookies which you would otherwise have blocked. This can also
986 be toggled via a web browser at the <application>Junkbuster</application>
987 internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
992 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
993 normally, <quote>toggle 0</quote> means that
994 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
995 proxy. Default: 1 (on).
1002 <emphasis>toggle 1</emphasis>
1009 For content filtering, i.e. the <quote>+filter</quote> and
1010 <quote>+deanimate-gif</quote> actions, it is necessary that
1011 <application>Junkbuster</application> buffers the entire document body.
1012 This can be potentially dangerous, since a server could just keep sending
1013 data indefinitely and wait for your RAM to exhaust. With nasty consequences.
1017 The <application>buffer-limit</application> option lets you set the maximum
1018 size in Kbytes that each buffer may use. When the documents buffer exceeds
1019 this size, it is flushed to the client unfiltered and no further attempt to
1020 filter the rest of it is made. Remember that there may multiple threads
1021 running, which might require increasing the <quote>buffer-limit</quote>
1022 Kbytes <emphasis>each</emphasis>, unless you have enabled
1023 <quote>single-threaded</quote> above.
1030 <emphasis>buffer-limit 4069</emphasis>
1037 To enable the web-based <filename>ijb.action</filename> file editor set
1038 <application>enable-edit-actions</application> to 1, or 0 to disable. Note
1039 that you must have compiled <application>JunkBuster</application> with
1040 support for this feature, otherwise this option has no effect. This
1041 internal page can be reached at <ulink
1042 url="http://i.j.b">http://i.j.b</ulink>.
1046 Security note: If this is enabled, anyone who can use the proxy
1047 can edit the actions file, and their changes will affect all users.
1048 For shared proxies, you probably want to disable this. Default: enabled.
1055 <emphasis>enable-edit-actions 1</emphasis>
1062 Allow <application>JunkBuster</application> to be toggled on and off
1063 remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
1064 1 to enable, and 0 to disable. Note that you must have compiled
1065 <application>JunkBuster</application> with support for this feature,
1066 otherwise this option has no effect.
1070 Security note: If this is enabled, anyone who can use the proxy can toggle
1071 it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
1072 their changes will affect all users. For shared proxies, you probably want to
1073 disable this. Default: enabled.
1080 <emphasis>enable-remote-toggle 1</emphasis>
1088 <!-- ~ End section ~ -->
1091 <!-- ~~~~~ New section ~~~~~ -->
1094 <title>Access Control List (ACL)</title>
1096 Access controls are included at the request of some ISPs and systems
1097 administrators, and are not usually needed by individual users. Please note
1098 the warnings in the FAQ that this proxy is not intended to be a substitute
1099 for a firewall or to encourage anyone to defer addressing basic security
1104 If no access settings are specified, the proxy talks to anyone that
1105 connects. If any access settings file are specified, then the proxy
1106 talks only to IP addresses permitted somewhere in this file and not
1107 denied later in this file.
1111 Summary -- if using an ACL:
1116 Client must have permission to receive service.
1121 LAST match in ACL wins.
1126 Default behavior is to deny service.
1131 The syntax for an entry in the Access Control List is:
1138 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
1145 Where the individual fields are:
1152 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
1154 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
1155 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1157 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1158 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1166 The field separator (FS) is whitespace (space or tab).
1170 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1171 forwarder (see below) or a gateway for a particular destination URL, the
1172 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1173 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1174 target. This is necessary because it may be impossible for the local
1175 <application>Junkbuster</application> to determine the address of the
1176 ultimate target (that's often what gateways are used for).
1180 Here are a few examples to show how the ACL features work:
1184 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1185 <emphasis>ALL</emphasis> destination addresses are OK:
1192 <emphasis>permit-access localhost</emphasis>
1199 A silly example to illustrate permitting any host on the class-C subnet with
1200 <application>Junkbuster</application> to go anywhere:
1207 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1214 Except deny one particular IP address from using it at all:
1221 <emphasis>deny-access ident.junkbusters.com</emphasis>
1228 You can also specify an explicit network address and subnet mask.
1229 Explicit addresses do not have to be resolved to be used.
1236 <emphasis>permit-access 207.153.200.0/24</emphasis>
1243 A subnet mask of 0 matches anything, so the next line permits everyone.
1250 <emphasis>permit-access 0.0.0.0/0</emphasis>
1257 Note, you <emphasis>cannot</emphasis> say:
1264 <emphasis>permit-access .org</emphasis>
1271 to allow all *.org domains. Every IP address listed must resolve fully.
1275 An ISP may want to provide a <application>Junkbuster</application> that is
1276 accessible by <quote>the world</quote> and yet restrict use of some of their
1277 private content to hosts on its internal network (i.e. its own subscribers).
1278 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1279 bit netmask). This is how they could do it:
1286 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1287 # with the following exceptions:
1289 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1290 # sites on the ISP's network
1292 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1295 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1303 Note that if some hostnames are listed with multiple IP addresses,
1304 the primary value returned by DNS (via gethostbyname()) is used. Default:
1305 Anyone can access the proxy.
1310 <!-- ~ End section ~ -->
1313 <!-- ~~~~~ New section ~~~~~ -->
1316 <title>Forwarding</title>
1319 This feature allows chaining of HTTP requests via multiple proxies.
1320 It can be used to better protect privacy and confidentiality when
1321 accessing specific domains by routing requests to those domains
1322 to a special purpose filtering proxy such as lpwa.com. Or to use
1323 a caching proxy to speed up browsing.
1327 It can also be used in an environment with multiple networks to route
1328 requests via multiple gateways allowing transparent access to multiple
1329 networks without having to modify browser configurations.
1333 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1334 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1335 hostname using DNS on the SOCKS server, not our local DNS client.
1339 The syntax of each line is:
1346 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1347 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1348 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1355 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1356 HTTP proxy but are made directly to the web servers.
1360 Lines are checked in sequence, and the last match wins.
1364 There is an implicit line equivalent to the following, which specifies that
1365 anything not finding a match on the list is to go out without forwarding
1366 or gateway protocol, like so:
1373 <emphasis>forward .* . </emphasis># implicit
1380 In the following common configuration, everything goes to Lucent's LPWA,
1381 except SSL on port 443 (which it doesn't handle):
1388 <emphasis>forward .* lpwa.com:8000</emphasis>
1389 <emphasis>forward :443 .</emphasis>
1396 See the FAQ for instructions on how to automate the login procedure for LPWA.
1397 Some users have reported difficulties related to LPWA's use of
1398 <quote>.</quote> as the last element of the domain, and have said that this
1399 can be fixed with this:
1406 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1413 (NOTE: the syntax for specifying target_domain has changed since the
1414 previous paragraph was written -- it will not work now. More information
1419 In this fictitious example, everything goes via an ISP's caching proxy,
1420 except requests to that ISP:
1427 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1428 <emphasis>forward myisp.net .</emphasis>
1435 For the @home network, we're told the forwarding configuration is this:
1443 <emphasis>forward .* proxy:8080</emphasis>
1450 Also, we're told they insist on getting cookies and JavaScript, so you should
1451 add home.com to the cookie file. We consider JavaScript a security risk.
1452 Java need not be enabled.
1456 In this example direct connections are made to all <quote>internal</quote>
1457 domains, but everything else goes through Lucent's LPWA by way of the
1458 company's SOCKS gateway to the Internet.
1465 <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1466 <emphasis>forward my_company.com .</emphasis>
1473 This is how you could set up a site that always uses SOCKS but no forwarders:
1480 <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
1487 An advanced example for network administrators:
1491 If you have links to multiple ISPs that provide various special content to
1492 their subscribers, you can configure forwarding to pass requests to the
1493 specific host that's connected to that ISP so that everybody can see all
1494 of the content on all of the ISPs.
1498 This is a bit tricky, but here's an example:
1503 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1504 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1505 forwarding like this:
1512 <emphasis>forward .* .</emphasis>
1513 <emphasis>forward isp-b.com host-b:8000</emphasis>
1520 host-b can run a <application>Junkbuster</application> proxy with forwarding
1528 <emphasis>forward .* .</emphasis>
1529 <emphasis>forward isp-a.com host-a:8000</emphasis>
1536 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1537 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1538 host-a or host-b and be able to browse the content on isp-a or isp-b.
1542 Here's another practical example, for University of Kent at
1543 Canterbury students with a network connection in their room, who
1544 need to use the University's Squid web cache.
1551 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1552 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1553 <emphasis>forward * . </emphasis> # Host with no domain specified
1554 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1555 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1556 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1557 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1564 If you intend to chain <application>Junkbuster</application> and
1565 <application>squid</application> locally, then chain as
1566 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1570 Your squid configuration could then look like this:
1577 # Define junkbuster as parent cache
1578 <!-- per feedback from user...
1579 cache_peer 127.0.0.1 8000 parent 0 no-query
1581 cache_peer 127.0.0.1 parent 8000 0 no-query
1583 # Define ACL for protocol FTP
1586 # Do not forward ACL FTP to junkbuster
1587 always_direct allow FTP
1589 # Do not forward ACL CONNECT (https) to junkbuster
1590 always_direct allow CONNECT
1592 # Forward the rest to junkbuster
1593 never_direct allow all
1601 <!-- ~ End section ~ -->
1604 <!-- ~~~~~ New section ~~~~~ -->
1607 <title>Windows GUI Options</title>
1609 Removed references to Win32. HB 09/23/01
1612 <application>Junkbuster</application> has a number of options specific to the
1613 Windows GUI interface:
1617 If <quote>activity-animation</quote> is set to 1, the
1618 <application>Junkbuster</application> icon will animate when
1619 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1626 <emphasis>activity-animation 1</emphasis>
1633 If <quote>log-messages</quote> is set to 1,
1634 <application>Junkbuster</application> will log messages to the console
1642 <emphasis>log-messages 1</emphasis>
1649 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1650 i.e. the amount of memory used for the log messages displayed in the
1651 console window, will be limited to <quote>log-max-lines</quote> (see below).
1655 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1656 eat up all your memory!
1663 <emphasis>log-buffer-size 1</emphasis>
1670 <application>log-max-lines</application> is the maximum number of lines held
1671 in the log buffer. See above.
1678 <emphasis>log-max-lines 200</emphasis>
1685 If <quote>log-highlight-messages</quote> is set to 1,
1686 <application>Junkbuster</application> will highlight portions of the log
1687 messages with a bold-faced font:
1694 <emphasis>log-highlight-messages 1</emphasis>
1701 The font used in the console window:
1708 <emphasis>log-font-name Comic Sans MS</emphasis>
1715 Font size used in the console window:
1722 <emphasis>log-font-size 8</emphasis>
1729 <quote>show-on-task-bar</quote> controls whether or not
1730 <application>Junkbuster</application> will appear as a button on the Task bar
1738 <emphasis>show-on-task-bar 0</emphasis>
1745 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1746 button will minimize <application>Junkbuster</application> instead of closing
1747 the program (close with the exit option on the File menu).
1754 <emphasis>close-button-minimizes 1</emphasis>
1761 The <quote>hide-console</quote> option is specific to the MS-Win console
1762 version of <application>JunkBuster</application>. If this option is used,
1763 <application>Junkbuster</application> will disconnect from and hide the
1780 <!-- ~ End section ~ -->
1783 <!-- ~~~~~ New section ~~~~~ -->
1784 <sect2 id="actionsfile">
1785 <title>The Actions File</title>
1788 The <quote>ijb.action</quote> file (formerly
1789 <filename>actionsfile</filename>) is used to define what actions
1790 <application>Junkbuster</application> takes, and thus determines how images,
1791 cookies and various other aspects of HTTP content and transactions are
1792 handled. Images can be anything you want, including ads, banners, or just
1793 some obnoxious image that you would rather not see. Cookies can be accepted
1794 or rejected, or accepted only during the current browser session (i.e.
1795 not written to disk). Changes to <filename>ijb.action</filename> should
1796 be immediately visible to <application>Junkbuster</application> without
1797 the need to restart.
1801 To determine which actions apply to a request, the URL of the request is
1802 compared to all patterns in this file. Every time it matches, the list of
1803 applicable actions for the URL is incrementally updated. You can trace
1804 this process by visiting <ulink
1805 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1809 The actions file can be edited with a browser by loading
1810 <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
1811 <quote>Edit Actions</quote>.
1815 There are four types of lines in this file: comments (begin with a
1816 <quote>#</quote> character), actions, aliases and patterns, all of which are
1817 explained below, as well as the configuration file syntax that
1818 <application>Junkbuster</application> understands.
1823 <!-- ~~~~~ New section ~~~~~ -->
1825 <title>URL Domain and Path Syntax</title>
1827 Generally, a pattern has the form <domain>/<path>, where both the
1828 <domain> and <path> part are optional. If you only specify a
1829 domain part, the <quote>/</quote> can be left out:
1833 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1834 <quote>www.example.com</quote>.
1838 <emphasis>www.example.com/</emphasis> - means exactly the same.
1842 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1843 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1847 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1852 <emphasis>index.html</emphasis> - matches nothing, since it would be
1853 interpreted as a domain name and there is no top-level domain called
1854 <quote>.html</quote>.
1858 The matching of the domain part offers some flexible options: if the
1859 domain starts or ends with a dot, it becomes unanchored at that end.
1864 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1865 <quote>.example.com</quote>.
1869 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1874 Additionally, there are wild-cards that you can use in the domain names
1875 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
1876 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1877 any single character. And you can define character classes in square
1878 brackets and they can be freely mixed:
1882 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1883 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1887 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1891 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1892 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1896 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1897 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1898 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1899 <quote>wwww.example.com</quote>.
1903 If <application>Junkbuster</application> was compiled with
1904 <quote>pcre</quote> support (default), Perl compatible regular expressions
1905 can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
1906 perlre</quote> (also available on <ulink
1907 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1908 for details. A brief discussion of regular expressions is in the
1909 <link linkend="regex">Appendix</link>. For instance:
1913 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1914 domain, with any path that includes <quote>advert</quote> followed
1915 immediately by one or more digits, then a <quote>.</quote> and ending in
1916 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1917 <quote>example.com/ads/advert2.jpg</quote>, and
1918 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1919 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1924 Please note that matching in the path is case
1925 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1926 sensitive at any point in the pattern by using the
1927 <quote>(?-i)</quote> switch:
1931 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1932 documents whose path starts with <quote>PaTtErN</quote> in
1933 <emphasis>exactly</emphasis> this capitalization.
1938 <!-- ~ End section ~ -->
1942 <!-- ~~~~~ New section ~~~~~ -->
1945 <title>Actions</title>
1947 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1948 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1949 action name in curly braces (e.g. {+some_action}), followed by a list of
1950 URLs to which the action applies. There are three classes of actions:
1958 Boolean (e.g. <quote>+/-block</quote>):
1964 <emphasis>{+name}</emphasis> # enable this action
1965 <emphasis>{-name}</emphasis> # disable this action
1975 parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1981 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1982 <emphasis>{-name}</emphasis> # disable action
1991 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1997 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1998 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1999 <emphasis>{-name}</emphasis> # disable this action totally
2010 If nothing is specified in this file, no <quote>actions</quote> are taken.
2011 So in this case <application>JunkBuster</application> would just be a
2012 normal, non-blocking, non-anonymizing proxy. You must specifically
2013 enable the privacy and blocking features you need (although the
2014 provided default <filename>ijb.action</filename> file will
2015 give a good starting point).
2019 Later defined actions always over-ride earlier ones. For multi-valued
2020 actions, the actions are applied in the order they are specified.
2024 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
2032 Add the specified HTTP header, which is not checked for validity.
2033 You may specify this many times to specify many different headers:
2039 <emphasis>+add-header{Name: value}</emphasis>
2049 Block this URL totally.
2055 <emphasis>+block</emphasis>
2065 De-animate all animated GIF images, i.e. reduce them to their last frame.
2066 This will also shrink the images considerably (in bytes, not pixels!). If
2067 the option <quote>first</quote> is given, the first frame of the animation
2068 is used as the replacement. If <quote>last</quote> is given, the last frame
2069 of the animation is used instead, which probably makes more sense for most
2070 banner animations, but also has the risk of not showing the entire last
2071 frame (if it is only a delta to an earlier frame).
2077 <emphasis>+deanimate-gifs{last}</emphasis>
2078 <emphasis>+deanimate-gifs{first}</emphasis>
2087 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
2088 HTTP/1.0 and downgrade the responses as well. Use this action for servers
2089 that use HTTP/1.1 protocol features that
2090 <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1
2091 is only partially implemented. Default is not to downgrade requests.
2097 <emphasis>+downgrade</emphasis>
2106 Many sites, like yahoo.com, don't just link to other sites. Instead, they
2107 will link to some script on their own server, giving the destination as a
2108 parameter, which will then redirect you to the final target. URLs resulting
2109 from this scheme typically look like:
2110 http://some.place/some_script?http://some.where-else.
2113 Sometimes, there are even multiple consecutive redirects encoded in the
2114 URL. These redirections via scripts make your web browsing more traceable,
2115 since the server from which you follow such a link can see where you go to.
2116 Apart from that, valuable bandwidth and time is wasted, while your browser
2117 ask the server for one redirect after the other. Plus, it feeds the
2121 The <quote>+fast-redirects</quote> option enables interception of these
2122 requests by <application>Junkbuster</application>, who will cut off all but
2123 the last valid URL in the request and send a local redirect back to your
2124 browser without contacting the remote site.
2130 <emphasis>+fast-redirects</emphasis>
2139 Filter the website through the re_filterfile:
2145 <emphasis>+filter{filename}</emphasis>
2154 Block any existing X-Forwarded-for header, and do not add a new one:
2160 <emphasis>+hide-forwarded</emphasis>
2169 If the browser sends a <quote>From:</quote> header containing your e-mail
2170 address, this either completely removes the header (<quote>block</quote>), or
2171 changes it to the specified e-mail address.
2177 <emphasis>+hide-from{block}</emphasis>
2178 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2187 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2188 can block it, forge a URL to the same server as the request (which is
2189 preferred because some sites will not send images otherwise) or set it to a
2190 constant string of your choice.
2196 <emphasis>+hide-referer{block}</emphasis>
2197 <emphasis>+hide-referer{forge}</emphasis>
2198 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2207 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2208 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2209 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2210 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2216 <emphasis>+hide-referrer{...}</emphasis>
2225 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2226 browser type. Warning! This breaks many web sites. Specify the
2227 user-agent value you want. Example, pretend to be using Netscape on
2234 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2241 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2247 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2252 (Don't change the version number from 1.0 - after all, why tell them?)
2259 <emphasis>+hide-user-agent{browser-type}</emphasis>
2269 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2270 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2271 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2277 <emphasis>+image</emphasis>
2286 Decides what to do with URLs that end up tagged with <quote>{+block
2287 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2288 send a HTML <quote>blocked</quote> page, usually resulting in a
2289 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2290 send a <quote>JunkBuster</quote> image.
2291 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2292 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2293 temporary redirect to the specified image. This has the advantage of the
2294 icon being being cached by the browser, which will speed up the display.
2300 <emphasis>+image-blocker{logo}</emphasis>
2301 <emphasis>+image-blocker{blank}</emphasis>
2302 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2311 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2312 action), <application>Junkbuster</application> will only allow CONNECT
2313 requests to port 443, which is the standard port for https as a
2318 The CONNECT methods exists in HTTP to allow access to secure websites
2319 (https:// URLs) through proxies. It works very simply: the proxy
2320 connects to the server on the specified port, and then short-circuits
2321 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2322 This can be a big security hole, since CONNECT-enabled proxies can
2323 be abused as TCP relays very easily.
2327 If you want to allow CONNECT for more ports than this, or want to forbid
2328 CONNECT altogether, you can specify a comma separated list of ports and
2329 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2337 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2338 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2339 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2340 <emphasis> #and above 500 are OK.</emphasis>
2350 <quote>+no-compression</quote> prevents the website from compressing the
2351 data. Some websites do this, which can be a problem for
2352 <application>Junkbuster</application>, since <quote>+filter</quote>,
2353 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2354 compressed data. This will slow down connections to those websites,
2355 though. Default is <quote>nocompression</quote> is turned on.
2362 <emphasis>+nocompression</emphasis>
2371 If the website sets cookies, <quote>no-cookies-keep</quote> will make sure
2372 they are erased when you exit and restart your web browser. This makes
2373 profiling cookies useless, but won't break sites which require cookies so
2374 that you can log in for transactions. Default: on.
2380 <emphasis>+no-cookies-keep</emphasis>
2389 Prevent the website from reading cookies:
2395 <emphasis>+no-cookies-read</emphasis>
2404 Prevent the website from setting cookies:
2410 <emphasis>+no-cookies-set</emphasis>
2419 Filter the website through a built-in filter to disable those obnoxious
2420 JavaScript pop-up windows via window.open(), etc. The two alternative
2421 spellings are equivalent.
2427 <emphasis>+no-popup</emphasis>
2428 <emphasis>+no-popups</emphasis>
2437 This action only applies if you are using a <filename>jarfile</filename>
2438 for saving cookies. It sends a cookie to every site stating that you do not
2439 accept any copyright on cookies sent to you, and asking them not to track
2440 you. Of course, this is a (relatively) unique header they could use to
2447 <emphasis>+vanilla-wafer</emphasis>
2456 This allows you to add an arbitrary cookie. It can be specified multiple
2457 times in order to add as many cookies as you like.
2463 <emphasis>+wafer{name=value}</emphasis>
2474 The meaning of any of the above is reversed by preceding the action with a
2475 <quote>-</quote>, in place of the <quote>+</quote>.
2483 Turn off cookies by default, then allow a few through for specified sites:
2490 # Turn off all persistent cookies
2491 { +no-cookies-read }
2493 # Allow cookies for this browser session ONLY
2494 { +no-cookies-keep }
2496 # Exceptions to the above, sites that benefit from persistent cookies
2497 { -no-cookies-read }
2499 { -no-cookies-keep }
2506 # Alternative way of saying the same thing
2507 {-no-cookies-set -no-cookies-read -no-cookies-keep}
2516 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2526 # Reverse it for these two sites, which don't work right without it.
2528 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2536 Turn on page filtering, with one exception for sourceforge:
2543 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2546 # But please don't re_filter code from sourceforge!
2548 .cvs.sourceforge.net
2555 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2556 Many of these use regular expressions that will expand to match multiple
2566 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2567 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2568 /.*/(ng)?adclient\.cgi
2569 /.*/(plain|live|rotate)[-_.]?ads?/
2570 /.*/(sponsor)s?[0-9]?/
2571 /.*/_?(plain|live)?ads?(-banners)?/
2573 /.*/ad(sdna_image|gifs?)/
2574 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2578 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2582 /.*/cgi-bin/centralad/getimage
2583 /.*/images/addver\.gif
2584 /.*/images/marketing/.*\.(gif|jpe?g)
2588 /.*/sponsors?[0-9]?/
2589 /.*/advert[0-9]+\.jpg
2596 /graphics/defaultAd/
2598 /image\.ng/transactionID
2599 /images/.*/.*_anim\.gif # alvin brattli
2600 /ip_img/.*\.(gif|jpe?g)
2604 /cgi-bin/nph-adclick.exe/
2605 /.*/Image/BannerAdvertising/
2607 /.*/adlib/server\.cgi
2616 <!-- ~ End section ~ -->
2619 <!-- ~~~~~ New section ~~~~~ -->
2621 <title>Aliases</title>
2623 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2624 as <quote>aliases</quote>, can be defined by combining other <quote>actions</quote>.
2625 These can in turn be invoked just like the built-in <quote>actions</quote>.
2626 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2627 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2628 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2629 <quote>-</quote>. Alias names are not case sensitive, and
2630 <emphasis>must be defined before anything</emphasis> else in the
2631 <filename>ijb.action</filename>file ! And there can only be one set of
2632 <quote>aliases</quote> defined.
2636 Now let's define a few aliases:
2643 # Useful customer aliases we can use later. These must come first!
2645 +no-cookies = +no-cookies-set +no-cookies-read
2646 -no-cookies = -no-cookies-set -no-cookies-read
2647 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2648 shop = -no-cookies -filter -fast-redirects
2649 +imageblock = +block +image
2651 #For people who don't like to type too much: ;-)
2654 c2 = -no-cookies-set +no-cookies-read
2655 c3 = +no-cookies-set -no-cookies-read
2656 #... etc. Customize to your heart's content.
2663 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2671 # These sites are very complex and require
2672 # minimal interference.
2674 .office.microsoft.com
2675 .windowsupdate.microsoft.com
2678 # Shopping sites - still want to block ads.
2681 .worldpay.com # for quietpc.com
2685 # These shops require pop-ups
2697 <!-- ~ End section ~ -->
2700 <!-- ~~~~~ New section ~~~~~ -->
2701 <sect2 id="filterfile">
2702 <title>The Filter File</title>
2704 The filter file defines what filtering of web pages
2705 <application>Junkbuster</application> does. The default filter file is
2706 <filename>re_filterfile</filename>, located in the config directory. In this
2707 file, <emphasis>any document content</emphasis>, whether viewable text or
2708 embedded non-visible content, can be changed.
2712 This file uses regular expressions to alter or remove any string in the
2713 target page. Some examples from the included default <filename>re_filterfile</filename>:
2717 Stop web pages from displaying annoying messages in the status bar by
2718 deleting such references:
2725 # The status bar is for displaying link targets, not pointless buzzwords.
2726 # Again, check it out on http://www.airport-cgn.de/.
2727 s/status='.*?';*//ig
2734 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2735 <quote>MicroSuck</quote>:
2742 s/microsoft(?!.com)/MicroSuck/ig
2749 Kill those auto-refresh tags:
2756 # Kill refresh tags. I like to refresh myself. Manually.
2757 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2759 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2760 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2768 <!-- ~ End section ~ -->
2772 <!-- ~~~~~ New section ~~~~~ -->
2775 <title>Templates</title>
2777 When <application>Junkbuster</application> displays one of its internal
2778 pages, such as a 404 Not Found error page, it uses the appropriate template.
2779 On Linux, BSD, and Unix, these are locate in
2780 <filename>/etc/junkbuster/templates</filename> by default. These may be
2781 customized, if desired.
2788 <!-- ~ End section ~ -->
2792 <!-- ~~~~~ New section ~~~~~ -->
2793 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2795 Install package, then run and enjoy! <application>JunkBuster</application>
2796 accepts only one command line option -- the configuration file to be
2797 used. Example Unix startup command:
2803 # /usr/sbin/junkbuster /etc/junkbuster/config
2809 An init script is provided for SuSE and Redhat.
2813 For for SuSE: /etc/rc.d/junkbuster start
2817 For RedHat: /etc/rc.d/init.d/junkbuster start
2822 If no configuration file is specified on the command line,
2823 <application>Junkbuster</application> will look for a file named
2824 <filename>config</filename> in the current directory. Except on Win32 where
2825 it will try <filename>config.txt</filename>. If no file is specified on the
2826 command line and no default configuration file can be found,
2827 <application>Junkbuster</application> will fail to start.
2831 Be sure your browser is set to use the proxy which is by default at
2832 localhost, port 8000. With <application>Netscape</application> (and
2833 <application>Mozilla</application>), this can be set under <literal>Edit
2834 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
2835 For <application>Internet Explorer</application>: <literal>Tools >
2836 Internet Properties -> Connections -> LAN Setting</literal>. Then,
2837 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
2838 localhost, Port: 8000). Include if HTTPS proxy support too.
2842 The included default configuration files should give a reasonable starting
2843 point, though may be somewhat aggressive in blocking junk. You will probably
2844 want to keep an eye out for sites that require persistent cookies, and add these to
2845 <filename>ijb.action</filename> as needed. By default, most of these will
2846 be accepted only during the current browser session, until you add them to
2847 the configuration. If you want the browser to handle this instead, you will
2848 need to edit <filename>ijb.action</filename> and disable this feature. If you
2849 use more than one browser, it would make more sense to let
2850 <application>Junkbuster</application> handle this. In which case, the
2851 browser(s) should be set to accept all cookies.
2855 If a particular site shows problems loading properly, try adding it
2856 to the <literal>{fragile}</literal> section of
2857 <filename>ijb.action</filename>. This will turn off most actions for
2862 HTTP/1.1 support is not fully implemented. If browsers that
2863 support HTTP/1.1 (like <application>Mozilla</application> or recent versions
2864 of I.E.) experience problems, you might try to force HTTP/1.0 compatibility.
2865 For Mozilla, look under <literal>Edit -> Preferences -> Debug ->
2866 Networking</literal>. Or set the <quote>+downgrade</quote> config option in
2867 <filename>ijb.action</filename>.
2871 After running <application>Junkbuster</application> for a while, you can
2872 start to fine tune the configuration to suit your personal, or site,
2873 preferences and requirements. There are many, many aspects that can
2874 be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
2875 can be adjusted by pointing your browser to
2876 <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
2877 and then follow the link to <quote>edit the actions list</quote>.
2878 (This is an internal page and does not require Internet access.)
2882 In fact, various aspects of <application>Junkbuster</application>
2883 configuration can be viewed from this page, including
2884 current configuration parameters, source code version numbers,
2885 the browser's request headers, and <quote>actions</quote> that apply
2886 to a given URL. In addition to the <filename>ijb.action</filename> file
2887 editor mentioned above, <application>Junkbuster</application> can also
2888 be turned <quote>on</quote> and <quote>off</quote> from this page.
2892 If you encounter problems, please verify it is a
2893 <application>Junkbuster</application> bug, by disabling
2894 <application>Junkbuster</application>, and then trying the same page.
2895 Also, try another browser if possible to eliminate browser or site
2896 problems. Before reporting it as a bug, see if there is not a configuration
2897 option that is enabled that is causing the page not to load. You can
2898 then add an exception for that page or site. If a bug, please report it to
2899 the developers (see below).
2905 <!-- ~~~~~ New section ~~~~~ -->
2906 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
2909 Please do not use the mailing lists for feature requests or
2910 bug reports. They are not as easily tracked this way!
2916 To be filled. mention the support forums as the primary channel of
2917 communication (bugs, feature requests, etc.)
2919 Feature requests and other questions should be posted to the <ulink
2920 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
2921 request page</ulink> at SourceForge. There is also an archive there.
2925 Anyone interested in actively participating in development and related
2926 discussions can join the appropriate mailing list
2927 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
2928 Archives are available here too.
2932 Please report bugs, using the form at
2933 <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
2934 Please try to verify that it is a <application>Junkbuster</application> bug,
2935 and not a browser or site bug first. Also, check to make sure this is not
2936 already a known bug. If you are using your own custom configuration, please
2937 try the stock configs to see if the problem is a configuration related bug.
2943 <!-- ~~~~~ New section ~~~~~ -->
2944 <sect1 id="copyright"><title>Copyright and History</title>
2947 <title>License</title>
2949 <application>Internet Junkbuster</application> is free software; you can
2950 redistribute it and/or modify it under the terms of the GNU General Public
2951 License as published by the Free Software Foundation; either version 2 of the
2952 License, or (at your option) any later version.
2956 This program is distributed in the hope that it will be useful, but WITHOUT
2957 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2958 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2959 details, which is available from <ulink
2960 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
2961 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2966 <!-- ~ End section ~ -->
2969 <!-- ~~~~~ New section ~~~~~ -->
2972 <title>History</title>
2974 <application>Junkbuster</application> was originally written by Anonymous
2976 url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
2977 Corporation</ulink>, and was released as free open-source software under the
2978 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
2979 Waldherr</ulink> made many improvements, and started the <ulink
2980 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
2981 rekindle development. There are now several active developers contributing.
2982 The last stable release was v2.0.2, which has now grown whiskers ;-).
2989 <!-- ~~~~~ New section ~~~~~ -->
2990 <sect1 id="seealso"><title>See also</title>
2995 <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>
3000 <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
3005 <ulink url="http://i.j.b/">http://i.j.b/</ulink>
3010 <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
3015 <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
3020 <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
3025 <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
3034 <!-- ~~~~~ New section ~~~~~ -->
3035 <sect1 id="appendix"><title>Appendix</title>
3038 <!-- ~~~~~ New section ~~~~~ -->
3040 <title>Regular Expressions</title>
3042 <application>Junkbuster</application> can use <quote>regular expressions</quote>
3043 in various config files. Assuming support for <quote>pcre</quote> (Perl
3044 Compatible Regular Expressions) is compiled in, which is the default. Such
3045 configuration directives do not require regular expressions, but they can be
3046 used to increase flexibility by matching a pattern with wild-cards against
3051 If you are reading this, you probably don't understand what <quote>regular
3052 expressions</quote> are, or what they can do. So this will be a very brief
3053 introduction only. A full explanation would require a book ;-)
3057 <quote>Regular expressions</quote> is a way of matching one character
3058 expression against another to see if it matches or not. One of the
3059 <quote>expressions</quote> is a literal string of readable characters
3060 (letter, numbers, etc), and the other is a complex string of literal
3061 characters combined with wild-cards, and other special characters, called
3062 meta-characters. The <quote>meta-characters</quote> have special meanings and
3063 are used to build the complex pattern to be matched against. Perl Compatible
3064 Regular Expressions is an enhanced form of the regular expression language
3065 with backward compatibility.
3069 To make a simple analogy, we do something similar when we use wild-card
3070 characters when listing files with the <command>dir</command> command in DOS.
3071 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
3072 character here is the asterisk which matches any and all characters. We can be
3073 more specific and use <literal>?</literal> to match just individual
3074 characters. So <quote>dir file?.text</quote> would match
3075 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
3076 matching, using a similar technique to <quote>regular expressions</quote>!
3080 Regular expressions do essentially the same thing, but are much, much more
3081 powerful. There are many more <quote>special characters</quote> and ways of
3082 building complex patterns however. Let's look at a few of the common ones,
3083 and then some examples:
3088 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
3089 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
3095 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
3102 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
3109 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
3116 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
3117 the following character should be taken literally. This is used where one of the
3118 special characters (e.g. <quote>.</quote>) needs to be taken literally and
3119 not as a special meta-character.
3125 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
3126 any of the enclosed characters are encountered.
3132 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
3133 or multiple sub-expressions.
3139 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
3140 <quote>or</quote> conditional statement. A match is successful if the
3141 sub-expression on either side of <quote>|</quote> matches.
3147 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
3148 <quote>string1</quote> is replaced by <quote>string2</quote> in this
3154 These are just some of the ones you are likely to use when matching URLs with
3155 <application>Junkbuster</application>, and is a long way from a definitive
3156 list. This is enough to get us started with a few simple examples which may
3157 be more illuminating:
3161 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
3162 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
3163 denote any character, zero or more times. In other words, any string at all.
3164 So we start with a literal forward slash, then our regular expression pattern
3165 (<quote>.*</quote>) another literal forward slash, the string
3166 <quote>banners</quote>, another forward slash, and lastly another
3167 <quote>.*</quote>. We are building
3168 a directory path here. This will match any file with the path that has a
3169 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
3170 any characters, and this could conceivably be more forward slashes, so it
3171 might expand into a much longer looking path. For example, this could match:
3172 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
3173 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
3174 possible combinations, just so it has <quote>banners</quote> in the path
3179 A now something a little more complex:
3183 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
3184 We have several literal forward slashes again (<quote>/</quote>), so we are
3185 building another expression that is a file path statement. We have another
3186 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
3187 it matches our expression. The only true literal that <emphasis>must
3188 match</emphasis> our pattern is <application>adv</application>, together with
3189 the forward slashes. What comes after the <quote>adv</quote> string is the
3194 Remember the <quote>?</quote> means the preceding expression (either a
3195 literal character or anything grouped with <quote>(...)</quote> in this case)
3196 can exist or not, since this means either zero or one match. So
3197 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
3198 individual sub-expressions: <quote>(er)</quote>,
3199 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
3200 means <quote>or</quote>. We have two of those. For instance,
3201 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
3202 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
3203 attempt at matching as many variations of <quote>advertisement</quote>, and
3204 similar, as possible. So this would expand to match just <quote>adv</quote>,
3205 or <quote>advert</quote>, or <quote>adverts</quote>, or
3206 <quote>advertising</quote>, or <quote>advertisement</quote>, or
3207 <quote>advertisements</quote>. You get the idea. But it would not match
3208 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
3209 changing our regular expression to:
3210 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
3215 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
3216 another path statement with forward slashes. Anything in the square brackets
3217 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
3218 shorthand expression to mean any digit one through nine. It is the same as
3219 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
3220 means one or more of the preceding expression must be included. The preceding
3221 expression here is what is in the square brackets -- in this case, any digit
3222 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
3223 This includes a <quote>|</quote>, so this needs to match the expression on
3224 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
3225 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
3226 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
3227 can be matched once or not at all. So we are building an expression here to
3228 match image GIF or JPEG type image file. It must include the literal
3229 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
3230 (which is now a literal, and not a special character, since it is escaped
3231 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
3232 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
3233 include: <quote>//advert1.jpg</quote>,
3234 <quote>/nasty/ads/advert1234.gif</quote>,
3235 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
3236 <quote>advert1.gif</quote> (no leading slash), or
3237 <quote>/adverts232.jpg</quote> (the expression does not include an
3238 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
3239 in the expression anywhere).
3243 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
3244 a substitution. <quote>MicroSuck</quote> will replace any occurrence of
3245 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
3246 means ignore case. The <quote>(?!.com)</quote> means
3247 the match should fail if <quote>microsoft</quote> is followed by
3248 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
3249 modifier. In case this is a hyperlink, we don't want to break it ;-).
3253 We are barely scratching the surface of regular expressions here so that you
3254 can understand the default <application>Junkbuster</application>
3255 configuration files, and maybe use this knowledge to customize your own
3256 installation. There is much, much more that can be done with regular
3257 expressions. Now that you know enough to get started, you can learn more on
3262 More reading on Perl Compatible Regular expressions:
3263 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
3272 This program is free software; you can redistribute it
3273 and/or modify it under the terms of the GNU General
3274 Public License as published by the Free Software
3275 Foundation; either version 2 of the License, or (at
3276 your option) any later version.
3278 This program is distributed in the hope that it will
3279 be useful, but WITHOUT ANY WARRANTY; without even the
3280 implied warranty of MERCHANTABILITY or FITNESS FOR A
3281 PARTICULAR PURPOSE. See the GNU General Public
3282 License for more details.
3284 The GNU General Public License should be included with
3285 this file. If not, you can view it at
3286 http://www.gnu.org/copyleft/gpl.html
3287 or write to the Free Software Foundation, Inc., 59
3288 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3290 $Log: user-manual.sgml,v $
3291 Revision 1.32 2002/03/03 09:26:06 joergs
3292 AmigaOS changes, config is now loaded from PROGDIR: instead of
3293 AmiTCP:db/junkbuster/ if no configuration file is specified on the
3296 Revision 1.31 2002/03/02 22:45:52 david__schmidt
3299 Revision 1.30 2002/03/02 22:00:14 hal9
3300 Updated 'New Features' list. Ran through spell-checker.
3302 Revision 1.29 2002/03/02 20:34:07 david__schmidt
3303 Update OS/2 build section
3305 Revision 1.28 2002/02/24 14:34:24 jongfoster
3306 Formatting changes. Now changing the doctype to DocBook XML 4.1
3307 will work - no other changes are needed.
3309 Revision 1.27 2002/01/11 14:14:32 hal9
3310 Added a very short section on Templates
3312 Revision 1.26 2002/01/09 20:02:50 hal9
3313 Fix bug re: auto-detect config file changes.
3315 Revision 1.25 2002/01/09 18:20:30 hal9
3316 Touch ups for *.action files.
3318 Revision 1.24 2001/12/02 01:13:42 hal9
3321 Revision 1.23 2001/12/02 00:20:41 hal9
3322 Updates for recent changes.
3324 Revision 1.22 2001/11/05 23:57:51 hal9
3325 Minor update for startup now daemon mode.
3327 Revision 1.21 2001/10/31 21:11:03 hal9
3328 Correct 2 minor errors
3330 Revision 1.18 2001/10/24 18:45:26 hal9
3331 *** empty log message ***
3333 Revision 1.17 2001/10/24 17:10:55 hal9
3334 Catching up with Jon's recent work, and a few other things.
3336 Revision 1.16 2001/10/21 17:19:21 swa
3337 wrong url in documentation
3339 Revision 1.15 2001/10/14 23:46:24 hal9
3340 Various minor changes. Fleshed out SEE ALSO section.
3342 Revision 1.13 2001/10/10 17:28:33 hal9
3345 Revision 1.12 2001/09/28 02:57:04 hal9
3348 Revision 1.11 2001/09/28 02:25:20 hal9
3351 Revision 1.9 2001/09/27 23:50:29 hal9
3352 A few changes. A short section on regular expression in appendix.
3354 Revision 1.8 2001/09/25 00:34:59 hal9
3355 Some additions, and re-arranging.
3357 Revision 1.7 2001/09/24 14:31:36 hal9
3360 Revision 1.6 2001/09/24 14:10:32 hal9
3361 Including David's OS/2 installation instructions.
3363 Revision 1.2 2001/09/13 15:27:40 swa
3366 Revision 1.1 2001/09/12 15:36:41 swa
3367 source files for junkbuster documentation
3369 Revision 1.3 2001/09/10 17:43:59 swa
3370 first proposal of a structure.
3372 Revision 1.2 2001/06/13 14:28:31 swa
3373 docs should have an author.
3375 Revision 1.1 2001/06/13 14:20:37 swa
3376 first import of project's documentation for the webserver.