X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=b0073171df8a9093c3d4b693906419ca597c9850;hb=372f943e90643159632e8c29ea168aade3eb35d2;hp=eca1a27184b984f76e539fd8d25453740a1d7e95;hpb=1e82652aa84cc4acea4f15a20f66cfdecbcdf2ce;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index eca1a271..b0073171 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -1,13 +1,12 @@ - + @@ -30,7 +28,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.24 2001/12/02 01:13:42 hal9 Exp $ +$Id: user-manual.sgml,v 1.47 2002/03/11 13:13:27 swa Exp $ @@ -42,18 +40,23 @@ Hal Burgiss - The user manual gives the users information on how to install and configure + The user manual gives users information on how to install, configure and use Internet Junkbuster. Internet - Junkbuster is an application that provides privacy and - security to users of the World Wide Web. + Junkbuster is a web proxy with advanced filtering capabilities + for protecting privacy, filtering web page content, managing cookies, + controlling access, and removing ads, banners, pop-ups and other obnoxious + Internet Junk. Junkbuster has a very flexible configuration and can be + customized to suit individual needs and tastes. Internet + Junkbuster has application for both stand-alone systems and + multi-user networks. You can find the latest version of the user manual at http://ijbswa.sourceforge.net/user-manual/. - - Feel free to send a note to the developers at ijbswa-developers@lists.sourceforge.net. - + + + @@ -64,28 +67,30 @@ You can find the latest version of the user manual at Introduction Internet Junkbuster is a web proxy with advanced - filtering capabilities for protecting privacy, filtering web page content, - managing cookies, controlling access, and removing ads, banners, pop-ups and - other obnoxious Internet Junk. Junkbuster has a - very flexible configuration and can be customized to suit individual needs - and tastes. Internet Junkbuster has application - for both stand-alone systems and multi-user networks. + filtering capabilities for protecting privacy, filtering and modifying web + page content, managing cookies, controlling access, and removing ads, + banners, pop-ups and other obnoxious Internet Junk. + Junkbuster has a very flexible configuration and + can be customized to suit individual needs and tastes. Internet + Junkbuster has application for both stand-alone systems and + multi-user networks. - This documentation is included with the current development version of - Internet Junkbuster and is incomplete at this + This documentation is included with the current BETA version of + Internet Junkbuster and is mostly complete at this point. The most up to date reference for the time being is still the comments in the source files and in the individual configuration files. Development - of version 3.0 is currently underway, and includes many significant changes and - enhancements over earlier verions. The target release date for stable v3.0 is - December 2001. + of version 3.0 is currently nearing completion, and includes many significant + changes and enhancements over earlier versions. The target release date for + stable v3.0 is soon ;-) - Since this is a development version, some features are in the process of - being implemented. This documentation may be slightly out of sync as a - result. And there are bugs, though hopefully not many! + Since this is a BETA version, not all new features are well tested. This + documentation may be slightly out of sync as a result (especially with + CVS sources). And there may be bugs, though hopefully + not many! @@ -103,55 +108,99 @@ You can find the latest version of the user manual at http://i.j.b). + Integrated browser based configuration and control utility (http://i.j.b). Browser-based tracing of rule + and filter effects. Modularized configuration that will allow for system wide settings, and - individual user settings. (not implemented yet) + individual user settings. (not implemented yet, probably a 3.1 feature) - Blocking of annoying pop-up browser windows (previously available as a - patch). + Blocking of annoying pop-up browser windows. - Support for HTTP/1.1 (partially implemented at this point). + HTTP/1.1 compliant (most, but not all 1.1 features are supported). Support for Perl Compatible Regular Expressions in the configuration files, and - generally a more sophisticated configuration syntax over previous versions. + generally a more sophisticated and flexible configuration syntax over + previous versions. - Web page content filtering. + GIF de-animation. + + + + + + Web page content filtering (removes banners based on size, + invisible web-bugs, JavaScript, pop-ups, status bar abuse, + etc.) + + + + + + Bypass many click-tracking scripts (avoids script redirection). + - Multi-threaded. + Multi-threaded (POSIX and native threads). - - + + + Auto-detection and re-reading of config file changes. + + - - In addition, the configuration is more versatile overall. + + + User-customizable HTML templates (e.g. 404 error page). + + + + + + Improved cookie management features (e.g. session based cookies). + + + + + + Builds from source on most UNIX-like systems. Packages available for: Linux + (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS. + + + + + + + In addition, the configuration is much more powerful and versatile over-all. + + + + @@ -167,8 +216,8 @@ You can find the latest version of the user manual at Junkbuster Home Page - for current release info. Junkbuster is also available - via Junkbuster + is also available via CVS. This is the recommended approach at this time. But please be aware that CVS is constantly changing, and it may break in mysterious ways. @@ -183,7 +232,7 @@ You can find the latest version of the user manual at - ./configure (--help to see options) - make (the make from gnu, gmake for *BSD) + ./configure (--help to see options) + make (the make from gnu, gmake for *BSD) su - make -n install (to see where all the files will go) - make install (to really install) + make -n install (to see where all the files will go) + make install (to really install) @@ -246,10 +295,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm + rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm @@ -290,10 +339,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm @@ -322,19 +371,12 @@ You can find the latest version of the user manual at 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 - - Junkbuster is packaged in a WarpIN self- installing archive. The self-installing program will be named depending on the release version, something like: - ijbos123.exe. In order to install it, simply run - this executable or double-click on its icon and follow the WarpIN + ijbos2_setup_1.2.3.exe. In order to install it, simply + run this executable or double-click on its icon and follow the WarpIN installation panels. A shadow of the Junkbuster executable will be placed in your startup folder so it will start automatically whenever OS/2 starts. @@ -347,22 +389,36 @@ Thanx David Schmidt! If you would like to build binary images on OS/2 yourself, you will need - a working EMX/GCC environment, plus several Unix-like tools. The Hobbes - OS/2 archive is a good place to start when building such an environment. - A set of Unix-like tools named gnupack is located here: - http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps - - - Once you have the source code unpacked as above, you can build the binaries - from the current/ directory: + a few Unix-like tools: autoconf, autoheader and sh. These tools will be + used to create the required config.h file, which is not part of the + source distribution because it differs based on platform. You will also + need a compiler. + The distribution has been created using IBM VisualAge compilers, but you + can use any compiler you like. GCC/EMX has the disadvantage of needing + to be single-threaded due to a limitation of EMX's implementation of the + select() socket call. + In addition to needing the source code distribution as outlined earlier, + you will want to extract the os2seutp directory from CVS: + cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup + + This will create a directory named os2setup/, which will contain the + Makefile.vac makefile and os2build.cmd + which is used to completely create the binary distribution. The sequence + of events for building the executable for yourself goes something like this: + + cd current + autoheader autoconf sh configure - make + cd ..\os2setup + nmake -f Makefile.vac + You will see this sequence laid out in os2build.cmd. @@ -396,11 +452,78 @@ configuration section below. HB.) -Junkbuster Configuration +JunkBuster Configuration + + All JunkBuster configuration is kept + in text files. These files can be edited with a text editor. + Many important aspects of JunkBuster can + also be controlled easily with a web browser. + + + + + + + +Controlling Junkbuster with Your Web Browser + + JunkBuster can be reached by the special + URL http://i.j.b/ (or alternately + http://ijbswa.sourceforge.net/config/, + which is an internal page. You will see the following section: + + + + + + +Please choose from the following options: + + * Show information about the current configuration + * Show the source code version numbers + * Show the client's request headers. + * Show which actions apply to a URL and why + * Toggle JunkBuster on or off + * Edit the actions list + + + + + + This should be self-explanatory. Note the last item is an editor for the + actions list, which is where much of the ad, banner, cookie, + and URL blocking magic is configured as well as other advanced features of + Junkbuster. This is an easy way to adjust various + aspects of Junkbuster configuration. The actions + file, and other configuration files, are explained in detail below. + Junkbuster will automatically detect any changes + to these files. + + - For Unix, *BSD and Linux, all configuraton files are located in - /etc/junkbuster/ by default. For MS Windows and OS/2, - these are all in the same directory as the + Toggle JunkBuster On or Off is handy for sites that might + have problems with your current actions and filters, or just to test if + a site misbehaves, whether it is JunkBuster + causing the problem or not. Junkbuster continues + to run as a proxy in this case, but all filtering is disabled. + + + + + + + + + + + + + +Configuration Files Overview + + For Unix, *BSD and Linux, all configuration files are located in + /etc/junkbuster/ by default. For MS Windows, OS/2, and + AmigaOS these are all in the same directory as the Junkbuster executable. The name and number of configuration files has changed from previous versions, and is subject to change as development progresses. @@ -418,9 +541,8 @@ configuration section below. HB.) The main configuration file is named config - on Linux, Unix, BSD, and OS/2, and config.txt on - Windows. On Amiga, it is - AmiTCP:db/junkbuster/config. + on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt + on Windows. @@ -430,8 +552,7 @@ configuration section below. HB.) actions relating to images, banners, pop-ups, access restrictions, banners and cookies. There is a CGI based editor for this file that can be accessed via http://i.j.b. This is the easiest method of - configuring actions. (Still under active development. Other actions + url="http://i.j.b">http://i.j.b. (Other actions files are included as well with differing levels of filtering and blocking, e.g. ijb-basic.action.) @@ -439,8 +560,9 @@ configuration section below. HB.) - The re_filterfile file can be used to rewrite the raw - page content, including text as well as embedded HTML and JavaScript. + The re_filterfile file can be used to re-write the raw + page content, including viewable text as well as embedded HTML and JavaScript, + and whatever else lurks on any given web page. @@ -452,8 +574,10 @@ configuration section below. HB.) can use Perl style regular expressions for maximum flexibility. All files use the # character to denote a comment. Such lines are not processed by Junkbuster. After - making any changes, restart Junkbuster in order - for the changes to take effect. + making any changes, there is no need to restart + Junkbuster in order for the changes to take + effect. Junkbuster should detect such changes + automatically. @@ -462,6 +586,8 @@ configuration section below. HB.) Also, what constitutes a default setting, may change, so please check all your configuration files on important issues. + + @@ -477,11 +603,11 @@ configuration section below. HB.) - + blockfile blocklist.ini - + @@ -531,15 +657,16 @@ configuration section below. HB.) - On Windows, Junkbuster - looks for these files in the same directory as the executable. On Unix and - OS/2, Junkbuster looks for these files in the current - working directory. In either case, an absolute path name can be used to + On Windows and AmigaOS, + Junkbuster looks for these files in the same + directory as the executable. On Unix and OS/2, + Junkbuster looks for these files in the current + working directory. In either case, an absolute path name can be used to avoid problems. - When development goes modular and multiuser, the blocker, filter, and + When development goes modular and multi-user, the blocker, filter, and per-user config will be stored in subdirectories of confdir. For now, only confdir/templates is used for storing HTML templates for CGI results. @@ -551,11 +678,11 @@ configuration section below. HB.) - + confdir /etc/junkbuster # No trailing /, please. - + @@ -567,11 +694,11 @@ configuration section below. HB.) - + logdir /var/log/junkbuster - + @@ -584,39 +711,49 @@ configuration section below. HB.) The ijb.action file contains patterns to specify the actions to apply to requests for each site. Default: Cookies to and from all destinations are kept only during the current browser session (i.e. they - are not saved to disk). Popups are disabled for all sites. All sites are - filtered if re_filterfile specified. No sites are blocked. An - empty image is displayed for filtered ads and other images (formerly - tinygif). The syntax of this file is explained in detail below. + are not saved to disk). Pop-ups are disabled for all sites. All sites are + filtered through selected sections of re_filterfile. No sites + are blocked. The JunkBuster logo is displayed for filtered ads and other + images . The syntax of this file is explained in detail below. - + actionsfile ijb.action - + - The re_filterfile file contains content modification rules. - These rules permit powerful changes on the content of Web pages, e.g., you - could disable your favourite JavaScript annoyances, rewrite the actual - content, or just have some fun replacing Microsoft with - MicroSuck wherever it appears on a Web page. Default: No - content modification, or whatever the developers are playing with :-/ + The re_filterfile file contains content modification rules + that use regular expressions. These rules permit powerful + changes on the content of Web pages, e.g., you could disable your favorite + JavaScript annoyances, re-write the actual displayed text, or just have some + fun replacing Microsoft with MicroSuck wherever + it appears on a Web page. Default: whatever the developers are playing with + :-/ + + + + Filtering requires buffering the page content, which may appear to slow down + page rendering since nothing is displayed until all content has passed + the filters. (It does not really take longer, but seems that way since + the page is not incrementally displayed.) This effect will be more noticeable + on slower connections. + - + re_filterfile re_filterfile - + @@ -648,11 +785,11 @@ configuration section below. HB.) - + logfile logfile - + @@ -665,11 +802,11 @@ configuration section below. HB.) - + #jarfile jarfile - + @@ -680,22 +817,22 @@ configuration section below. HB.) with the effect that access to untrusted sites will be granted, if a link from a trusted referrer was used. The link target will then be added to the trustfile. This is a very restrictive feature that typical - users most propably want to leave disabled. Default: Disabled, don't use the + users most probably want to leave disabled. Default: Disabled, don't use the trust mechanism. - + #trustfile trust - + - If you use the trust mechanism, it is a good idea to write up some online + If you use the trust mechanism, it is a good idea to write up some on-line documentation about your blocking policy and to specify the URL(s) here. They will appear on the page that your users receive when they try to access untrusted content. Use multiple times for multiple URLs. Default: Don't @@ -704,12 +841,12 @@ configuration section below. HB.) - + trust-info-url http://www.your-site.com/why_we_block.html trust-info-url http://www.your-site.com/what_we_allow.html - + @@ -737,11 +874,11 @@ configuration section below. HB.) - + #admin-address fill@me.in.please - + @@ -751,30 +888,30 @@ configuration section below. HB.) configuration and policies. It is used in many of the proxy-generated pages and its use is highly recommended in multi-user installations, since your users will want to know why certain content is blocked or modified. Default: - Don't show a link to online documentation. + Don't show a link to on-line documentation. - + proxy-info-url http://www.your-site.com/proxy.html - + Listen-address specifies the address and port where Junkbuster will listen for connections from your - Web browser. The default is to listen on the localhost port 8000, and + Web browser. The default is to listen on the localhost port 8118, and this is suitable for most users. (In your web browser, under proxy configuration, list the proxy server as localhost and the - port as 8000). + port as 8118). - If you already have another service running on port 8000, or if you want to + If you already have another service running on port 8118, or if you want to serve requests from other machines (e.g. on your local network) as well, you will need to override the default. The syntax is listen-address [<ip-address>]:<port>. If you leave @@ -793,11 +930,11 @@ configuration section below. HB.) - + - listen-address 192.168.0.1:8000 + listen-address 192.168.0.1:8118 - + @@ -808,18 +945,18 @@ configuration section below. HB.) - + - listen-address :8000 + listen-address :8118 - + If you do this, consider using ACLs (see aclfile above). Note: you will need to point your browser(s) to the address and port that you have - configured here. Default: localhost:8000 (127.0.0.1:8000). + configured here. Default: localhost:8118 (127.0.0.1:8118). @@ -829,10 +966,10 @@ configuration section below. HB.) levels of debug are probably only of interest to developers. - - - - + + + + debug 1 # GPC = show each GET/POST/CONNECT request debug 2 # CONN = show each connection status debug 4 # IO = show I/O status @@ -841,15 +978,15 @@ configuration section below. HB.) debug 32 # FRC = debug force feature debug 64 # REF = debug regular expression filter debug 128 # = debug fast redirects - debug 256 # = debug GIF deanimation + debug 256 # = debug GIF de-animation debug 512 # CLF = Common Log Format - debug 1024 # = debug kill popups + debug 1024 # = debug kill pop-ups debug 4096 # INFO = Startup banner and warnings. debug 8192 # ERROR = Non-fatal errors - - - - + + + + It is highly recommended that you enable ERROR @@ -873,11 +1010,11 @@ configuration section below. HB.) - + debug 15 # same as setting the first 4 listed above - + @@ -887,13 +1024,13 @@ configuration section below. HB.) - + debug 1 # URLs debug 4096 # Info debug 8192 # Errors - *we highly recommended enabling this* - + @@ -909,11 +1046,11 @@ configuration section below. HB.) - + #single-threaded - + @@ -945,17 +1082,17 @@ configuration section below. HB.) - + toggle 1 - + For content filtering, i.e. the +filter and - +deanimate-gif actions, it is neccessary that + +deanimate-gif actions, it is necessary that Junkbuster buffers the entire document body. This can be potentially dangerous, since a server could just keep sending data indefinitely and wait for your RAM to exhaust. With nasty consequences. @@ -973,11 +1110,11 @@ configuration section below. HB.) - + buffer-limit 4069 - + @@ -998,11 +1135,11 @@ configuration section below. HB.) - + enable-edit-actions 1 - + @@ -1023,11 +1160,11 @@ configuration section below. HB.) - + enable-remote-toggle 1 - + @@ -1081,11 +1218,11 @@ configuration section below. HB.) - + ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ] - + @@ -1095,7 +1232,7 @@ configuration section below. HB.) - + ACTION = permit-access or deny-access @@ -1105,7 +1242,7 @@ configuration section below. HB.) DST_ADDR = server or forwarder hostname or dotted IP address DST_MASKLEN = number of bits in the subnet mask for the target - + @@ -1135,11 +1272,11 @@ configuration section below. HB.) - + permit-access localhost - + @@ -1150,11 +1287,11 @@ configuration section below. HB.) - + permit-access www.junkbusters.com/24 - + @@ -1164,11 +1301,11 @@ configuration section below. HB.) - + deny-access ident.junkbusters.com - + @@ -1179,11 +1316,11 @@ configuration section below. HB.) - + permit-access 207.153.200.0/24 - + @@ -1193,11 +1330,11 @@ configuration section below. HB.) - + permit-access 0.0.0.0/0 - + @@ -1207,11 +1344,11 @@ configuration section below. HB.) - + permit-access .org - + @@ -1229,7 +1366,7 @@ configuration section below. HB.) - + permit-access 0.0.0.0/0 0.0.0.0/0 # other clients can go anywhere # with the following exceptions: @@ -1243,7 +1380,7 @@ configuration section below. HB.) permit 123.124.0.0/16 0.0.0.0/0 # the ISP's clients can go # anywhere - + @@ -1289,13 +1426,13 @@ configuration section below. HB.) - + forward target_domain[:port] http_proxy_host[:port] forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port] forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port] - + @@ -1316,11 +1453,11 @@ configuration section below. HB.) - + forward .* . # implicit - + @@ -1331,12 +1468,12 @@ configuration section below. HB.) - + forward .* lpwa.com:8000 forward :443 . - + @@ -1349,16 +1486,16 @@ configuration section below. HB.) - + forward lpwa. lpwa.com:8000 - + - (NOTE: the syntax for specifiying target_domain has changed since the + (NOTE: the syntax for specifying target_domain has changed since the previous paragraph was written -- it will not work now. More information is welcome.) @@ -1370,12 +1507,12 @@ configuration section below. HB.) - + forward .* caching.myisp.net:8000 forward myisp.net . - + @@ -1386,11 +1523,11 @@ configuration section below. HB.) - + forward .* proxy:8080 - + @@ -1408,12 +1545,12 @@ configuration section below. HB.) - + forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080 forward my_company.com . - + @@ -1423,11 +1560,11 @@ configuration section below. HB.) - + forward-socks4a .* . firewall.my_company.com:1080 - + @@ -1455,12 +1592,12 @@ configuration section below. HB.) - + forward .* . - forward isp-b.com host-b:8000 + forward isp-b.com host-b:8118 - + @@ -1471,12 +1608,12 @@ configuration section below. HB.) - + forward .* . - forward isp-a.com host-a:8000 + forward isp-a.com host-a:8118 - + @@ -1494,7 +1631,7 @@ configuration section below. HB.) - + forward *. ssbcache.ukc.ac.uk:3128 # Use the proxy, except for: forward .ukc.ac.uk . # Anything on the same domain as us @@ -1504,7 +1641,7 @@ configuration section below. HB.) forward localhost.localdomain . # Loopback address forward www.ukc.mirror.ac.uk . # Specific host - + @@ -1520,13 +1657,13 @@ configuration section below. HB.) - + # Define junkbuster as parent cache - cache_peer 127.0.0.1 parent 8000 0 no-query + cache_peer 127.0.0.1 parent 8118 0 no-query # Define ACL for protocol FTP acl FTP proto FTP @@ -1540,7 +1677,7 @@ configuration section below. HB.) # Forward the rest to junkbuster never_direct allow all - + @@ -1569,11 +1706,11 @@ Removed references to Win32. HB 09/23/01 - + activity-animation 1 - + @@ -1585,11 +1722,11 @@ Removed references to Win32. HB 09/23/01 - + log-messages 1 - + @@ -1606,11 +1743,11 @@ Removed references to Win32. HB 09/23/01 - + log-buffer-size 1 - + @@ -1621,11 +1758,11 @@ Removed references to Win32. HB 09/23/01 - + log-max-lines 200 - + @@ -1637,11 +1774,11 @@ Removed references to Win32. HB 09/23/01 - + log-highlight-messages 1 - + @@ -1651,11 +1788,11 @@ Removed references to Win32. HB 09/23/01 - + log-font-name Comic Sans MS - + @@ -1665,11 +1802,11 @@ Removed references to Win32. HB 09/23/01 - + log-font-size 8 - + @@ -1681,11 +1818,11 @@ Removed references to Win32. HB 09/23/01 - + show-on-task-bar 0 - + @@ -1697,11 +1834,11 @@ Removed references to Win32. HB 09/23/01 - + close-button-minimizes 1 - + @@ -1714,11 +1851,11 @@ Removed references to Win32. HB 09/23/01 - + #hide-console - + @@ -1819,10 +1956,10 @@ Removed references to Win32. HB 09/23/01 - Additionally, there are wildcards that you can use in the domain names - themselves. They work pretty similar to shell wildcards: * + Additionally, there are wild-cards that you can use in the domain names + themselves. They work pretty similar to shell wild-cards: * stands for zero or more arbitrary characters, ? stands for - any single character. And you can define charachter classes in square + any single character. And you can define character classes in square brackets and they can be freely mixed: @@ -1850,7 +1987,7 @@ Removed references to Win32. HB 09/23/01 If Junkbuster was compiled with pcre support (default), Perl compatible regular expressions - can be used. See the pcre/docs/ direcory or man + can be used. See the pcre/docs/ directory or man perlre (also available on http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A brief discussion of regular expressions is in the @@ -1907,12 +2044,12 @@ Removed references to Win32. HB 09/23/01 - + {+name} # enable this action {-name} # disable this action - + @@ -1920,16 +2057,16 @@ Removed references to Win32. HB 09/23/01 - Parameterized (e.g. +/-hide-user-agent): + parameterized (e.g. +/-hide-user-agent): - + {+name{param}} # enable action and set parameter to param {-name} # disable action - + @@ -1940,13 +2077,13 @@ Removed references to Win32. HB 09/23/01 - + {+name{param}} # enable action and add parameter param {-name{param}} # remove the parameter param {-name} # disable this action totally - + @@ -1982,11 +2119,11 @@ Removed references to Win32. HB 09/23/01 - + +add-header{Name: value} - + @@ -1998,11 +2135,11 @@ Removed references to Win32. HB 09/23/01 - + +block - + @@ -2014,18 +2151,18 @@ Removed references to Win32. HB 09/23/01 This will also shrink the images considerably (in bytes, not pixels!). If the option first is given, the first frame of the animation is used as the replacement. If last is given, the last frame - of the animation is used instead, which propably makes more sense for most + of the animation is used instead, which probably makes more sense for most banner animations, but also has the risk of not showing the entire last frame (if it is only a delta to an earlier frame). - + +deanimate-gifs{last} +deanimate-gifs{first} - + @@ -2040,11 +2177,11 @@ Removed references to Win32. HB 09/23/01 - + +downgrade - + @@ -2059,7 +2196,7 @@ Removed references to Win32. HB 09/23/01 Sometimes, there are even multiple consecutive redirects encoded in the - URL. These redirections via scripts make your web browing more traceable, + URL. These redirections via scripts make your web browsing more traceable, since the server from which you follow such a link can see where you go to. Apart from that, valuable bandwidth and time is wasted, while your browser ask the server for one redirect after the other. Plus, it feeds the @@ -2073,28 +2210,91 @@ Removed references to Win32. HB 09/23/01 - + +fast-redirects - + - Filter the website through the re_filterfile: - + Apply the filters in the section_header + section of the re_filterfile file to the site(s). + Re_filterfile sections are grouped according to like + functionality. + + - + - +filter{filename} + +filter{section_header} - + + + + Filter sections that are pre-defined in the supplied + re_filterfile include: + + +
+ + + html-annoyances: Get rid of particularly annoying HTML abuse. + + + + + js-annoyances: Get rid of particularly annoying JavaScript abuse + + + + + no-poups: Kill all popups in JS and HTML + + + + + frameset-borders: Give frames a border + + + + + webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking) + + + + + no-refresh: Automatic refresh sucks on auto-dialup lines + + + + + fun: Text replacements for subversive browsing fun! + + + + + nimda: Remove (virus) Nimda code. + + + + + banners-by-size: Kill banners by size + + + + + crude-parental: Kill all web pages that contain the words "sex" or "warez" + + +
+ @@ -2103,11 +2303,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-forwarded - + @@ -2120,12 +2320,12 @@ Removed references to Win32. HB 09/23/01 - + +hide-from{block} +hide-from{spam@sittingduck.xqq} - + @@ -2139,13 +2339,13 @@ Removed references to Win32. HB 09/23/01 - + +hide-referer{block} +hide-referer{forge} +hide-referer{http://nowhere.com} - + @@ -2159,11 +2359,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-referrer{...} - + @@ -2177,11 +2377,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)} - + @@ -2220,11 +2420,11 @@ Removed references to Win32. HB 09/23/01 - + +image - + @@ -2232,24 +2432,29 @@ Removed references to Win32. HB 09/23/01 Decides what to do with URLs that end up tagged with {+block - +image}. There are 4 options. -image-blocker will - send a HTML blocked page, usually resulting in a - broken image icon. +image-blocker{logo} will - send a JunkBuster image. - +image-blocker{blank} will send a 1x1 transparent GIF image. - And finally, +image-blocker{http://xyz.com} will send a HTTP - temporary redirect to the specified image. This has the advantage of the - icon being being cached by the browser, which will speed up the display. + +image}, e.g an advertizement. There are five options. + -image-blocker will send a HTML blocked page, + usually resulting in a broken image icon. + +image-blocker{logo} will send a JunkBuster + logo image. +image-blocker{blank} will send a 1x1 + transparent GIF image. And finally, + +image-blocker{http://xyz.com} will send a HTTP temporary + redirect to the specified image. This has the advantage of the icon being + being cached by the browser, which will speed up the display. + +image-blocker{pattern} will send a checkboard type pattern, + which scales better than the logo (which can get blocky if the browser + enlarges it too much). - + +image-blocker{logo} +image-blocker{blank} + +image-blocker{pattern} +image-blocker{http://i.j.b/send-banner} - + @@ -2280,14 +2485,14 @@ Removed references to Win32. HB 09/23/01 - + +limit-connect{443} # This is the default and need no be specified. +limit-connect{80,443} # Ports 80 and 443 are OK. +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100 #and above 500 are OK. - + @@ -2305,11 +2510,11 @@ Removed references to Win32. HB 09/23/01 - + +nocompression - + @@ -2323,11 +2528,11 @@ Removed references to Win32. HB 09/23/01 - + +no-cookies-keep - + @@ -2338,11 +2543,11 @@ Removed references to Win32. HB 09/23/01 - + +no-cookies-read - + @@ -2353,11 +2558,11 @@ Removed references to Win32. HB 09/23/01 - + +no-cookies-set - + @@ -2370,12 +2575,12 @@ Removed references to Win32. HB 09/23/01 - + +no-popup +no-popups - + @@ -2390,11 +2595,11 @@ Removed references to Win32. HB 09/23/01 - + +vanilla-wafer - + @@ -2406,11 +2611,11 @@ Removed references to Win32. HB 09/23/01 - + +wafer{name=value} - + @@ -2433,15 +2638,15 @@ Removed references to Win32. HB 09/23/01 - + - # Turn off all persistant cookies + # Turn off all persistent cookies { +no-cookies-read } { +no-cookies-set } # Allow cookies for this browser session ONLY { +no-cookies-keep } - # Execeptions to the above, sites that benefit from persistant cookies + # Exceptions to the above, sites that benefit from persistent cookies { -no-cookies-read } { -no-cookies-set } { -no-cookies-keep } @@ -2456,7 +2661,7 @@ Removed references to Win32. HB 09/23/01 .sourceforge.net .sf.net - + @@ -2466,7 +2671,7 @@ Removed references to Win32. HB 09/23/01 - + # Turn them off! {+fast-redirects} @@ -2476,26 +2681,30 @@ Removed references to Win32. HB 09/23/01 www.ukc.ac.uk/cgi-bin/wac\.cgi\? login.yahoo.com - + - Turn on page filtering, with one exception for sourceforge: - + Turn on page filtering according to rules in the defined sections + of refilterfile, and make one exception for + sourceforge: + - + - # Run everything through the default filter file (re_filterfile): - {+filter} - - # But please don't re_filter code from sourceforge! + # Run everything through the filter file, using only the + # specified sections: + +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\ + +filter{webbugs} +filter{nimda} +filter{banners-by-size} + + # Then disable filtering of code from sourceforge! {-filter} .cvs.sourceforge.net - + @@ -2507,7 +2716,7 @@ Removed references to Win32. HB 09/23/01 - + # Blocklist: {+block} @@ -2555,7 +2764,7 @@ Removed references to Win32. HB 09/23/01 /.*/adlib/server\.cgi /autoads/ - + @@ -2586,7 +2795,7 @@ Removed references to Win32. HB 09/23/01 - + # Useful customer aliases we can use later. These must come first! {{alias}} @@ -2603,7 +2812,7 @@ Removed references to Win32. HB 09/23/01 c3 = +no-cookies-set -no-cookies-read #... etc. Customize to your heart's content. - + @@ -2614,7 +2823,7 @@ Removed references to Win32. HB 09/23/01 - + # These sites are very complex and require # minimal interference. @@ -2635,7 +2844,7 @@ Removed references to Win32. HB 09/23/01 .dabs.com .overclockers.co.uk - + @@ -2649,16 +2858,24 @@ Removed references to Win32. HB 09/23/01 The Filter File - The filter file defines what filtering of web pages - Junkbuster does. The default filter file is - re_filterfile, located in the config directory. In this - file, any document content, whether viewable text or - embedded non-visible content, can be changed. + Any web page can be dynamically modified with the filter file. This + modification can be removal, or re-writing, of any web page content, + including tags and non-visible content. The default filter file is + re_filterfile, located in the config directory. + + + + The included example file is divided into sections. Each section begins + with the FILTER keyword, followed by the identifier + for that section, e.g. FILTER: webbugs. Each section performs + a similar type of filtering, such as html-annoyances. + This file uses regular expressions to alter or remove any string in the - target page. Some examples from the included default re_filterfile: + target page. The expressions can only operate on one line at a time. Some + examples from the included default re_filterfile: @@ -2668,59 +2885,101 @@ Removed references to Win32. HB 09/23/01 - + - # The status bar is for displaying link targets, not pointless buzzwords. - # Again, check it out on http://www.airport-cgn.de/. - s/status='.*?';*//ig + FILTER: html-annoyances + + # New browser windows should be resizeable and have a location and status + # bar. Make it so. + # + s/resizable="?(no|0)"?/resizable=1/ig s/noresize/yesresize/ig + s/location="?(no|0)"?/location=1/ig s/status="?(no|0)"?/status=1/ig + s/scrolling="?(no|0|Auto)"?/scrolling=1/ig + s/menubar="?(no|0)"?/menubar=1/ig + + # The <BLINK> tag was a crime! + # + s*<blink>|</blink>**ig + + # Is this evil? + # + #s/framespacing="?(no|0)"?//ig + #s/margin(height|width)=[0-9]*//gi - + Just for kicks, replace any occurrence of Microsoft with - MicroSuck: + MicroSuck, and have a little fun with topical buzzwords: - + + FILTER: fun + s/microsoft(?!.com)/MicroSuck/ig + + # Buzzword Bingo: + # + s/industry-leading|cutting-edge|award-winning/<font color=red><b>BINGO!</b></font>/ig - + - Kill those auto-refresh tags: + Kill those pesky little web-bugs: - + - # Kill refresh tags. I like to refresh myself. Manually. - # check it out on http://www.airport-cgn.de/ and go to the arrivals page. - # - s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i - s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i + # webbugs: Squish WebBugs (1x1 invisible GIFs used for user tracking) + FILTER: webbugs + + s/<img\s+[^>]*?(width|height)\s*=\s*['"]?1\D[^>]*?(width|height)\s*=\s*['"]?1(\D[^>]*?)?>/<!-- Squished WebBug -->/sig - + + + + + + + + +Templates + + When Junkbuster displays one of its internal + pages, such as a 404 Not Found error page, it uses the appropriate template. + On Linux, BSD, and Unix, these are located in + /etc/junkbuster/templates by default. These may be + customized, if desired. + + + + + + + + Quickstart to Using Junkbuster - Install package, then run and enjoy! Junbuster - accepts only one command line option -- the configuration file to be - used. Example Unix startup command: + Install package, then run and enjoy! JunkBuster + is typically started by specifying the main configuration file to be + used on the command line. Example Unix startup command: @@ -2747,28 +3006,27 @@ For RedHat: /etc/rc.d/init.d/junkbuster start If no configuration file is specified on the command line, Junkbuster will look for a file named - config in the current directory. Except on Amiga where - it will look for AmiTCP:db/junkbuster/config and Win32 - where it will try config.txt. If no file is specified - on the command line and no default configuration file can be found, + config in the current directory. Except on Win32 where + it will try config.txt. If no file is specified on the + command line and no default configuration file can be found, Junkbuster will fail to start. Be sure your browser is set to use the proxy which is by default at - localhost, port 8000. With Netscape (and + localhost, port 8118. With Netscape (and Mozilla), this can be set under Edit -> Preferences -> Advanced -> Proxies -> HTTP Proxy. For Internet Explorer: Tools > Internet Properties -> Connections -> LAN Setting. Then, check Use Proxy and fill in the appropriate info (Address: - localhost, Port: 8000). Include if HTTPS proxy support too. + localhost, Port: 8118). Include if HTTPS proxy support too. The included default configuration files should give a reasonable starting point, though may be somewhat aggressive in blocking junk. You will probably - want to keep an eye out for sites that require persistant cookies, and add these to + want to keep an eye out for sites that require persistent cookies, and add these to ijb.action as needed. By default, most of these will be accepted only during the current browser session, until you add them to the configuration. If you want the browser to handle this instead, you will @@ -2786,11 +3044,12 @@ For RedHat: /etc/rc.d/init.d/junkbuster start - HTTP/1.1 support is not fully implemented. If browsers that - support HTTP/1.1 (like Mozilla or recent versions - of I.E.) experience problems, you might try to force HTTP/1.0 compatiblity. - For Mozilla, look under Edit -> Preferences -> Debug -> - Networking. Or set the +downgrade config option in + Junkbuster is HTTP/1.1 compliant, but not all 1.1 + features are as yet implemented. If browsers that support HTTP/1.1 (like + Mozilla or recent versions of I.E.) experience + problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look + under Edit -> Preferences -> Debug -> Networking. + Or set the +downgrade config option in ijb.action. @@ -2826,19 +3085,126 @@ For RedHat: /etc/rc.d/init.d/junkbuster start the developers (see below). + + + + + +Command Line Options + + JunkBuster may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + JunkBuster will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + + + + + + -Contact the Developers + +Contacting the Developers, Bug Reporting and Feature +Requests - - Feature requests and other questions should be posted to the Feature - request page at SourceForge. There is also an archive there. +We value your feedback. However, to provide you with the best support, +please note: + + + + Use the Sourceforge support forum to get + help. + + Submit bugs only thru our Sourceforge bug + forum. +Make sure that the bug has not already been submitted. Please try to +verify that it is a Junkbuster bug, and not +a browser or site bug first. If you are using your own custom configuration, +please try the stock configs to see if the problem is a configuration +related bug. And if not using the latest development snapshot, please +try the latest one. Or even better, CVS sources. + + + + Submit feature requests only thru our Sourceforge feature request forum. + + + + + + + +For any other issues, feel free to use the mailing lists. @@ -2848,14 +3214,6 @@ communication (bugs, feature requests, etc.) Archives are available here too. - - Please report bugs, using the form at - Sourceforge. - Please try to verify that it is a Junkbuster bug, - and not a browser or site bug first. Also, check to make sure this is not - already a known bug. - - @@ -2892,13 +3250,13 @@ communication (bugs, feature requests, etc.) Junkbuster was originally written by Anonymous Coders and JunkBusters + url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's Corporation, and was released as free open-source software under the GNU GPL. Stefan Waldherr made many improvements, and started the SourceForge project to - rekindle development. The last stable release was v2.0.2, which has now - grown whiskers ;-). + rekindle development. There are now several active developers contributing. + The last stable release was v2.0.2, which has now grown whiskers ;-). @@ -2962,7 +3320,7 @@ communication (bugs, feature requests, etc.) in various config files. Assuming support for pcre (Perl Compatible Regular Expressions) is compiled in, which is the default. Such configuration directives do not require regular expressions, but they can be - used to increase flexibility by matching a pattern with wildcards against + used to increase flexibility by matching a pattern with wild-cards against URLs. @@ -2977,18 +3335,18 @@ communication (bugs, feature requests, etc.) expression against another to see if it matches or not. One of the expressions is a literal string of readable characters (letter, numbers, etc), and the other is a complex string of literal - characters combined with wildcards, and other special characters, called - metacharacters. The metacharacters have special meanings and + characters combined with wild-cards, and other special characters, called + meta-characters. The meta-characters have special meanings and are used to build the complex pattern to be matched against. Perl Compatible Regular Expressions is an enhanced form of the regular expression language with backward compatibility. - To make a simple analogy, we do something similar when we use wildcard + To make a simple analogy, we do something similar when we use wild-card characters when listing files with the dir command in DOS. *.* matches all filenames. The special - character here is the asterik which matches any and all characters. We can be + character here is the asterisk which matches any and all characters. We can be more specific and use ? to match just individual characters. So dir file?.text would match file1.txt, file2.txt, etc. We are pattern @@ -3035,7 +3393,7 @@ communication (bugs, feature requests, etc.) \ - The escape character denotes that the following character should be taken literally. This is used where one of the special characters (e.g. .) needs to be taken literally and - not as a special metacharacter. + not as a special meta-character. @@ -3048,7 +3406,7 @@ communication (bugs, feature requests, etc.) - () - Pararentheses are used to group a sub-expression, + () - parentheses are used to group a sub-expression, or multiple sub-expressions. @@ -3160,7 +3518,7 @@ communication (bugs, feature requests, etc.) s/microsoft(?!.com)/MicroSuck/i - This is - a substitution. MicroSuck will replace any occurence of + a substitution. MicroSuck will replace any occurrence of microsoft. The i at the end of the expression means ignore case. The (?!.com) means the match should fail if microsoft is followed by @@ -3184,6 +3542,141 @@ communication (bugs, feature requests, etc.) + + + + + +JunkBuster's Internal Pages + + + Since JunkBuster proxies each requested + web page, it is easy for JunkBuster to + trap certain URLs. In this way, we can talk directly to + JunkBuster, and see how it is + configured, see how our rules are being applied, change these + rules and other configuration options, and even turn + JunkBuster's filtering off, all with + a web browser. + + + + + The URLs listed below are the special ones that allow direct access + to JunkBuster. Of course, + JunkBuster must be running to access these. If + not, you will get a friendly error message. + + + + + + + + + Junkbuster main page: + +
+ + http://ijbswa.sourceforge.net/config/ + +
+ + Alternately, this may be reached at http://i.j.b/, + but this variation may not work as reliably as the above in some + configurations. + + + + + + Show information about the current configuration: + +
+ + http://ijbswa.sourceforge.net/config/show-status + +
+ + + + + Show the source code version numbers: + +
+ + http://ijbswa.sourceforge.net/config/show-version + +
+ + + + + Show the client's request headers: + +
+ + http://ijbswa.sourceforge.net/config/show-request + +
+ + + + + Show which actions apply to a URL and why: + +
+ + http://ijbswa.sourceforge.net/config/show-url-info + +
+ + + + + Toggle JunkBuster on or off: + +
+ + http://ijbswa.sourceforge.net/config/toggle + +
+ + Short cuts. Turn off, then on: + +
+ + http://ijbswa.sourceforge.net/config/toggle?set=disable + +
+
+ + http://ijbswa.sourceforge.net/config/toggle?set=enable + +
+ + + + + Edit the actions list file: + +
+ + http://ijbswa.sourceforge.net/config/edit-actions + +
+ + + + + + + These may be bookmarked for quick reference. + + + + +