By: Junkbuster Developers
- $Id: user-manual.sgml,v 1.24 2001/12/02 01:13:42 hal9 Exp $
+ $Id: user-manual.sgml,v 1.42 2002/03/07 18:16:55 swa Exp $
- The user manual gives the users information on how to install and
- configure Internet Junkbuster. Internet Junkbuster is an application
+ 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.
You can find the latest version of the user manual at
2.5. [10]Windows
2.6. [11]Other
- 3. [12]Junkbuster Configuration
+ 3. [12]Invoking and Configuring JunkBuster
- 3.1. [13]The Main Configuration File
- 3.2. [14]The Actions File
- 3.3. [15]The Filter File
+ 3.1. [13]Command Line Options
+ 3.2. [14]The Main Configuration File
- 4. [16]Quickstart to Using Junkbuster
- 5. [17]Contact the Developers
- 6. [18]Copyright and History
+ 3.2.1. [15]Defining Other Configuration Files
+ 3.2.2. [16]Other Configuration Options
+ 3.2.3. [17]Access Control List (ACL)
+ 3.2.4. [18]Forwarding
+ 3.2.5. [19]Windows GUI Options
+
+ 3.3. [20]The Actions File
+
+ 3.3.1. [21]URL Domain and Path Syntax
+ 3.3.2. [22]Actions
+ 3.3.3. [23]Aliases
+
+ 3.4. [24]The Filter File
+ 3.5. [25]Templates
+
+ 4. [26]Quickstart to Using Junkbuster
+ 5. [27]Contacting the Developers, Bug Reporting and Feature Requests
+ 6. [28]Copyright and History
- 6.1. [19]License
- 6.2. [20]History
+ 6.1. [29]License
+ 6.2. [30]History
- 7. [21]See also
- 8. [22]Appendix
+ 7. [31]See also
+ 8. [32]Appendix
- 8.1. [23]Regular Expressions
+ 8.1. [33]Regular Expressions
+ 11
+ 12
+ 13
+ 14
+ 15
+ 16
+ 17
+ 18
+ 19
+
1. 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.
-
- This documentation is included with the current development version of
- Internet Junkbuster and is incomplete 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.
-
- 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!
+ 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 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 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 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!
_________________________________________________________________
1.1. New Features
blocking and cookie management, this is a list of new features
currently under development:
- * A browser based configuration utility (WIP at [24]http://i.j.b).
+ * Integrated browser based configuration and control utility
+ ([34]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)
- * Blocking of annoying pop-up browser windows (previously available
- as a patch).
- * Support for HTTP/1.1 (partially implemented at this point).
+ settings, and individual user settings. (not implemented yet,
+ probably a 3.1 feature)
+ * Blocking of annoying pop-up browser windows.
+ * 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.
- * Web page content filtering.
- * Multi-threaded.
-
- In addition, the configuration is more versatile overall.
+ configuration files, and generally a more sophisticated and
+ flexible configuration syntax over previous versions.
+ * 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 (POSIX and native threads).
+ * Auto-detection and re-reading of config file changes.
+ * 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.
+ * In addition, the configuration is much more powerful and versatile
+ over-all.
_________________________________________________________________
2. Installation
Junkbuster is available as raw source code, or pre-compiled binaries.
- See the [25]Junkbuster Home Page for current release info. Junkbuster
- is also available via [26]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.
+ See the [35]Junkbuster Home Page for binaries and current release
+ info. Junkbuster is also available via [36]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.
_________________________________________________________________
2.1. Source
For gzipped tar archives, unpack the source:
tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.9_alpha
+ cd ijb_source_2.9.11_beta
For retrieving the current CVS sources, you'll need the CVS package
installed first. To download CVS source:
Then, in either case, to build from tarball/CVS source:
- ./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)
For Redhat and SuSE Linux RPM packages, see below.
_________________________________________________________________
This will create both binary and src RPMs in the usual places.
Example:
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
- /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
This will place the Junkbuster configuration files in
/etc/junkbuster/, and log files in /var/log/junkbuster/.
This will create both binary and src RPMs in the usual places.
Example:
- /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
- /usr/src/packages/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
This will place the Junkbuster configuration files in
/etc/junkbuster/, and log files in /var/log/junkbuster/.
2.4. OS/2
- The OS/2 version of Junkbuster requires the EMX runtime library to be
- installed. The EMX runtime library is available on the hobbes OS/2
- archive, among many other locations:
- [27]http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emx
- rt.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
- installation panels. A shadow of the Junkbuster executable will be
- placed in your startup folder so it will start automatically whenever
- OS/2 starts.
+ version, something like: 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.
The directory you choose to install Junkbuster into will contain all
of the configuration files.
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:
- [28]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:
-
+ need 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 os2
+setup
+
+ 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.
_________________________________________________________________
2.5. Windows
Some quick notes on other Operating Systems.
- For FreeBSD (and other *BSDs?), the build will need gmake instead of
- the included make. gmake is available from [29]http://www.gnu.org. The
- rest should be the same as above for Linux/Unix.
+ For FreeBSD (and other *BSDs?), the build will require gmake instead
+ of the included make. gmake is available from [37]http://www.gnu.org.
+ The rest should be the same as above for Linux/Unix.
_________________________________________________________________
-3. Junkbuster Configuration
+3. Invoking and Configuring JunkBuster
- 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 Junkbuster executable. The name and number
- of configuration files has changed from previous versions, and is
- subject to change as development progresses.
+ 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.
- The installed defaults provide a reasonable starting point. For the
- time being, there are only three default configuration files (this
- will change in time):
+ The installed defaults provide a reasonable starting point, though
+ possibly aggressive by some standards. For the time being, there are
+ only three default configuration files (this will change in time):
* 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.
+ OS/2, and AmigaOS and config.txt on Windows.
* The ijb.action file is used to define various "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 [30]http://i.j.b. This is the easiest method of
- configuring actions. (Still under active development.)
+ accessed via [38]http://i.j.b. This is the easiest method of
+ configuring actions. (Other actions files are included as well
+ with differing levels of filtering and blocking, e.g.
+ ijb-basic.action.)
* The re_filterfile file can be used to rewrite the raw page
content, including text as well as embedded HTML and JavaScript.
ijb.action and re_filterfile 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.
+ changes, there is no need to restart Junkbuster in order for the
+ changes to take effect. Junkbuster should detect such changes
+ automatically.
While under development, the configuration content is subject to
change. The below documentation may not be accurate by the time you
please check all your configuration files on important issues.
_________________________________________________________________
-3.1. The Main Configuration File
+3.1. 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
+ After (optionally) writing the PID file, assume the user ID of
+ USER. 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.
+ _________________________________________________________________
+
+3.2. The Main Configuration File
Again, the main configuration file is named config on Linux/Unix/BSD
and OS/2, and config.txt on Windows. Configuration lines consist of an
There are various aspects of Junkbuster behavior that can be tuned.
_________________________________________________________________
-3.1.1. Defining Other Configuration Files
+3.2.1. Defining Other Configuration Files
Junkbuster can use a number of other files to tell it what ads to
block, what cookies to accept, etc. This section of the configuration
file tells Junkbuster where to find all those other files.
- 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 avoid problems.
+ 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.
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
- [31]below.
+ they are not saved to disk). Pop-ups are disabled for all sites. All
+ sites are filtered if "re_filterfile" specified according to the
+ contents 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 [39]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
+ could disable your favorite 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 :-/
+ 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
The logfile is where all logging and error messages are written. The
trusted referrers, 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
+ restrictive feature that typical 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 documentation about your blocking policy and to specify the
+ 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 display links on the "untrusted" info page.
trust-info-url http://www.your-site.com/what_we_allow.html
_________________________________________________________________
-3.1.2. Other Configuration Options
+3.2.2. Other Configuration Options
This part of the configuration file contains options that control how
Junkbuster operates.
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.
+ 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 this is suitable for most users. (In
+ 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").
+ "localhost" and the port as "8118").
- If you already have another service running on port 8000, or if you
+ 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 out the IP
and has another outside connection with a different address. You want
it to serve requests from inside only:
- listen-address 192.168.0.1:8000
+ listen-address 192.168.0.1:8118
If you want it to listen on all addresses (including the outside
connection):
- 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).
+ have configured here. Default: localhost:8118 (127.0.0.1:8118).
The debug option sets the level of debugging information to log in the
logfile (and to the console in the Windows version). A debug level of
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
you want to temporarily disable Junkbuster, e.g., to access a site
that requires cookies which you would otherwise have blocked. This can
also be toggled via a web browser at the Junkbuster internal address
- of [32]http://i.j.b on any platform.
+ of [40]http://i.j.b on any platform.
"toggle 1" means Junkbuster runs normally, "toggle 0" means that
Junkbuster becomes a non-anonymizing non-blocking proxy. Default: 1
toggle 1
For content filtering, i.e. the "+filter" and "+deanimate-gif"
- actions, it is neccessary that Junkbuster buffers the entire document
+ 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.
To enable the web-based ijb.action file editor set enable-edit-actions
to 1, or 0 to disable. Note that you must have compiled JunkBuster
with support for this feature, otherwise this option has no effect.
- This internal page can be reached at [33]http://i.j.b.
+ This internal page can be reached at [41]http://i.j.b.
Security note: If this is enabled, anyone who can use the proxy can
edit the actions file, and their changes will affect all users. For
feature, otherwise this option has no effect.
Security note: If this is enabled, anyone who can use the proxy can
- toggle it on or off (see [34]http://i.j.b), and their changes will
+ toggle it on or off (see [42]http://i.j.b), and their changes will
affect all users. For shared proxies, you probably want to disable
this. Default: enabled.
enable-remote-toggle 1
_________________________________________________________________
-3.1.3. Access Control List (ACL)
+3.2.3. Access Control List (ACL)
Access controls are included at the request of some ISPs and systems
administrators, and are not usually needed by individual users. Please
Anyone can access the proxy.
_________________________________________________________________
-3.1.4. Forwarding
+3.2.4. Forwarding
This feature allows chaining of HTTP requests via multiple proxies. It
can be used to better protect privacy and confidentiality when
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.)
forwarding like this:
forward .* .
- forward isp-b.com host-b:8000
+ forward isp-b.com host-b:8118
host-b can run a Junkbuster proxy with forwarding like this:
forward .* .
- forward isp-a.com host-a:8000
+ forward isp-a.com host-a:8118
Now, anyone on the Internet (including users on host-a and host-b) can
set their browser's proxy to either host-a or host-b and be able to
# 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
never_direct allow all
_________________________________________________________________
-3.1.5. Windows GUI Options
+3.2.5. Windows GUI Options
Junkbuster has a number of options specific to the Windows GUI
interface:
#hide-console
_________________________________________________________________
-3.2. The Actions File
+3.3. The Actions File
The "ijb.action" file (formerly actionsfile) is used to define what
actions Junkbuster takes, and thus determines how images, cookies and
Images can be anything you want, including ads, banners, or just some
obnoxious image that you would rather not see. Cookies can be accepted
or rejected, or accepted only during the current browser session (i.e.
- not written to disk).
+ not written to disk). Changes to ijb.action should be immediately
+ visible to Junkbuster without the need to restart.
To determine which actions apply to a request, the URL of the request
is compared to all patterns in this file. Every time it matches, the
list of applicable actions for the URL is incrementally updated. You
- can trace this process by visiting [35]http://i.j.b/show-url-info.
+ can trace this process by visiting [43]http://i.j.b/show-url-info.
The actions file can be edited with a browser by loading
- [36]http://i.j.b/, and then select "Edit Actions".
+ [44]http://i.j.b/, and then select "Edit Actions".
There are four types of lines in this file: comments (begin with a "#"
character), actions, aliases and patterns, all of which are explained
understands.
_________________________________________________________________
-3.2.1. URL Domain and Path Syntax
+3.3.1. URL Domain and Path Syntax
Generally, a pattern has the form <domain>/<path>, where both the
<domain> and <path> part are optional. If you only specify a domain
www. - matches any domain that STARTS with "www".
- Additionally, there are wildcards that you can use in the domain names
- themselves. They work pretty similar to shell wildcards: "*" stands
- for zero or more arbitrary characters, "?" stands for any single
- character. And you can define charachter classes in square brackets
- and they can be freely mixed:
+ 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 character classes in square
+ brackets and they can be freely mixed:
ad*.example.com - matches "adserver.example.com", "ads.example.com",
etc but not "sfads.example.com".
If Junkbuster was compiled with "pcre" support (default), Perl
compatible regular expressions can be used. See the pcre/docs/
- direcory or "man perlre" (also available on
- [37]http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A
- brief discussion of regular expressions is in the [38]Appendix. For
+ directory or "man perlre" (also available on
+ [45]http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A
+ brief discussion of regular expressions is in the [46]Appendix. For
instance:
/.*/advert[0-9]+\.jpe?g - would match a URL from any domain, with any
starts with "PaTtErN" in exactly this capitalization.
_________________________________________________________________
-3.2.2. Actions
+3.3.2. Actions
Actions are enabled if preceded with a "+", and disabled if preceded
with a "-". Actions are invoked by enclosing the action name in curly
{+name} # enable this action
{-name} # disable this action
- * Parameterized (e.g. "+/-hide-user-agent"):
+ * parameterized (e.g. "+/-hide-user-agent"):
{+name{param}} # enable action and set parameter to "param"
{-name} # disable action
frame. 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
+ last frame 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).
the final target. URLs resulting from this scheme typically look
like: http://some.place/some_script?http://some.where-else.
Sometimes, there are even multiple consecutive redirects encoded
- in the URL. These redirections via scripts make your web browing
+ in the 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
Turn off cookies by default, then allow a few through for specified
sites:
- # 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 cookie
- s
+ # Exceptions to the above, sites that benefit from persistent cookies
{ -no-cookies-read }
{ -no-cookies-set }
{ -no-cookies-keep }
/autoads/
_________________________________________________________________
-3.2.3. Aliases
+3.3.3. Aliases
Custom "actions", known to Junkbuster as "aliases", can be defined by
combining other "actions". These can in turn be invoked just like the
.overclockers.co.uk
_________________________________________________________________
-3.3. The Filter File
+3.4. 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
enter for me-->/i
_________________________________________________________________
+3.5. 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 locate in /etc/junkbuster/templates by default. These
+ may be customized, if desired.
+ _________________________________________________________________
+
4. Quickstart to Using Junkbuster
- Install package, then run and enjoy! Junbuster accepts only one
+ Install package, then run and enjoy! JunkBuster accepts only one
command line option -- the configuration file to be used. Example Unix
startup command:
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, Junkbuster will
- fail to start.
+ 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 Mozilla), this can be set
+ 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.
+ (Address: 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 ijb.action as needed. By default,
+ 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 need to edit ijb.action and
the {fragile} section of ijb.action. This will turn off most actions
for this site.
- 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 ijb.action.
+ 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.
After running Junkbuster for a while, you can start to fine tune the
configuration to suit your personal, or site, preferences and
requirements. There are many, many aspects that can be customized.
"Actions" (as specified in ijb.action) can be adjusted by pointing
- your browser to [39]http://i.j.b/, and then follow the link to "edit
+ your browser to [47]http://i.j.b/, and then follow the link to "edit
the actions list". (This is an internal page and does not require
Internet access.)
developers (see below).
_________________________________________________________________
-5. Contact the Developers
+5. Contacting the Developers, Bug Reporting and Feature Requests
- Feature requests and other questions should be posted to the
- [40]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 [48]support forum to get help.
+ * Submit bugs only thru our [49]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 [50]feature request forum.
+
+ For any other issues, feel free to use the [51]mailing lists.
Anyone interested in actively participating in development and related
- discussions can join the appropriate mailing list [41]here. Archives
+ discussions can join the appropriate mailing list [52]here. Archives
are available here too.
-
- Please report bugs, using the form at [42]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.
_________________________________________________________________
6. Copyright and History
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details, which is available from
- [43]the Free Software Foundation, Inc, 59 Temple Place - Suite 330,
+ [53]the Free Software Foundation, Inc, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
_________________________________________________________________
6.2. History
Junkbuster was originally written by Anonymous Coders and
- [44]JunkBusters Corporation, and was released as free open-source
- software under the GNU GPL. [45]Stefan Waldherr made many
- improvements, and started the [46]SourceForge project to rekindle
- development. The last stable release was v2.0.2, which has now grown
- whiskers ;-).
+ [54]Junkbuster's Corporation, and was released as free open-source
+ software under the GNU GPL. [55]Stefan Waldherr made many
+ improvements, and started the [56]SourceForge project to rekindle
+ development. There are now several active developers contributing. The
+ last stable release was v2.0.2, which has now grown whiskers ;-).
_________________________________________________________________
7. See also
- [47]http://sourceforge.net/projects/ijbswa
+ [57]http://sourceforge.net/projects/ijbswa
- [48]http://ijbswa.sourceforge.net/
+ [58]http://ijbswa.sourceforge.net/
- [49]http://i.j.b/
+ [59]http://i.j.b/
- [50]http://www.junkbusters.com/ht/en/cookies.html
+ [60]http://www.junkbusters.com/ht/en/cookies.html
- [51]http://www.waldherr.org/junkbuster/
+ [61]http://www.waldherr.org/junkbuster/
- [52]http://privacy.net/analyze/
+ [62]http://privacy.net/analyze/
- [53]http://www.squid-cache.org/
+ [63]http://www.squid-cache.org/
_________________________________________________________________
8. Appendix
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 URLs.
+ flexibility by matching a pattern with wild-cards against URLs.
If you are reading this, you probably don't understand what "regular
expressions" are, or what they can do. So this will be a very brief
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 are used to build the
+ 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
- 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 more specific and use ? to
- match just individual characters. So "dir file?.text" would match
- "file1.txt", "file2.txt", etc. We are pattern matching, using a
- similar technique to "regular expressions"!
+ 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
+ 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 matching,
+ using a similar technique to "regular expressions"!
Regular expressions do essentially the same thing, but are much, much
more powerful. There are many more "special characters" and ways of
\ - 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.
+ meta-character.
[] - Characters enclosed in brackets will be matched if any of the
enclosed characters are encountered.
- () - Pararentheses are used to group a sub-expression, or multiple
+ () - parentheses are used to group a sub-expression, or multiple
sub-expressions.
| - The "bar" character works like an "or" conditional statement. A
not in the expression anywhere).
s/microsoft(?!.com)/MicroSuck/i - This is a substitution. "MicroSuck"
- will replace any occurence of "microsoft". The "i" at the end of the
+ 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 ".com". In other words, this acts
like a "NOT" modifier. In case this is a hyperlink, we don't want to
you know enough to get started, you can learn more on your own :/
More reading on Perl Compatible Regular expressions:
- [54]http://www.perldoc.com/perl5.6/pod/perlre.html
+ [64]http://www.perldoc.com/perl5.6/pod/perlre.html
References
+ Visible links
1. http://ijbswa.sourceforge.net/user-manual/
2. mailto:ijbswa-developers@lists.sourceforge.net
3. file://localhost/home/swa/sf/current/doc/source/tmp.html#INTRODUCTION
- 4. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN27
+ 4. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN28
5. file://localhost/home/swa/sf/current/doc/source/tmp.html#INSTALLATION
6. file://localhost/home/swa/sf/current/doc/source/tmp.html#INSTALLATION-SOURCE
7. file://localhost/home/swa/sf/current/doc/source/tmp.html#INSTALLATION-RH
10. file://localhost/home/swa/sf/current/doc/source/tmp.html#INSTALLATION-WIN
11. file://localhost/home/swa/sf/current/doc/source/tmp.html#INSTALLATION-OTHER
12. file://localhost/home/swa/sf/current/doc/source/tmp.html#CONFIGURATION
- 13. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN158
- 14. file://localhost/home/swa/sf/current/doc/source/tmp.html#ACTIONSFILE
- 15. file://localhost/home/swa/sf/current/doc/source/tmp.html#FILTERFILE
- 16. file://localhost/home/swa/sf/current/doc/source/tmp.html#QUICKSTART
- 17. file://localhost/home/swa/sf/current/doc/source/tmp.html#CONTACT
- 18. file://localhost/home/swa/sf/current/doc/source/tmp.html#COPYRIGHT
- 19. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1174
- 20. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1180
- 21. file://localhost/home/swa/sf/current/doc/source/tmp.html#SEEALSO
- 22. file://localhost/home/swa/sf/current/doc/source/tmp.html#APPENDIX
- 23. file://localhost/home/swa/sf/current/doc/source/tmp.html#REGEX
- 24. http://i.j.b/
- 25. http://sourceforge.net/projects/ijbswa/
- 26. http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/
- 27. 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
- 28. http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps
- 29. http://www.gnu.org/
- 30. http://i.j.b/
- 31. file://localhost/home/swa/sf/current/doc/source/tmp.html#ACTIONSFILE
- 32. http://i.j.b/
- 33. http://i.j.b/
+ 13. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN173
+ 14. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN212
+ 15. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN245
+ 16. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN336
+ 17. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN473
+ 18. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN561
+ 19. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN670
+ 20. file://localhost/home/swa/sf/current/doc/source/tmp.html#ACTIONSFILE
+ 21. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN767
+ 22. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN841
+ 23. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1114
+ 24. file://localhost/home/swa/sf/current/doc/source/tmp.html#FILTERFILE
+ 25. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1171
+ 26. file://localhost/home/swa/sf/current/doc/source/tmp.html#QUICKSTART
+ 27. file://localhost/home/swa/sf/current/doc/source/tmp.html#CONTACT
+ 28. file://localhost/home/swa/sf/current/doc/source/tmp.html#COPYRIGHT
+ 29. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1246
+ 30. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1252
+ 31. file://localhost/home/swa/sf/current/doc/source/tmp.html#SEEALSO
+ 32. file://localhost/home/swa/sf/current/doc/source/tmp.html#APPENDIX
+ 33. file://localhost/home/swa/sf/current/doc/source/tmp.html#REGEX
34. http://i.j.b/
- 35. http://i.j.b/show-url-info
- 36. http://i.j.b/
- 37. http://www.perldoc.com/perl5.6/pod/perlre.html
- 38. file://localhost/home/swa/sf/current/doc/source/tmp.html#REGEX
- 39. http://i.j.b/
- 40. http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
- 41. http://sourceforge.net/mail/?group_id=11118
- 42. http://sourceforge.net/tracker/?group_id=11118&atid=111118
- 43. http://www.gnu.org/copyleft/gpl.html
- 44. http://www.junkbusters.com/ht/en/ijbfaq.html
- 45. http://www.waldherr.org/junkbuster/
- 46. http://sourceforge.net/projects/ijbswa/
- 47. http://sourceforge.net/projects/ijbswa
- 48. http://ijbswa.sourceforge.net/
- 49. http://i.j.b/
- 50. http://www.junkbusters.com/ht/en/cookies.html
- 51. http://www.waldherr.org/junkbuster/
- 52. http://privacy.net/analyze/
- 53. http://www.squid-cache.org/
- 54. http://www.perldoc.com/perl5.6/pod/perlre.html
+ 35. http://sourceforge.net/projects/ijbswa/
+ 36. http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/
+ 37. http://www.gnu.org/
+ 38. http://i.j.b/
+ 39. file://localhost/home/swa/sf/current/doc/source/tmp.html#ACTIONSFILE
+ 40. http://i.j.b/
+ 41. http://i.j.b/
+ 42. http://i.j.b/
+ 43. http://i.j.b/show-url-info
+ 44. http://i.j.b/
+ 45. http://www.perldoc.com/perl5.6/pod/perlre.html
+ 46. file://localhost/home/swa/sf/current/doc/source/tmp.html#REGEX
+ 47. http://i.j.b/
+ 48. http://sourceforge.net/tracker/?group_id=11118&atid=211118
+ 49. http://sourceforge.net/tracker/?group_id=11118&atid=111118
+ 50. http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
+ 51. http://sourceforge.net/mail/?group_id=11118
+ 52. http://sourceforge.net/mail/?group_id=11118
+ 53. http://www.gnu.org/copyleft/gpl.html
+ 54. http://www.junkbusters.com/ht/en/ijbfaq.html
+ 55. http://www.waldherr.org/junkbuster/
+ 56. http://sourceforge.net/projects/ijbswa/
+ 57. http://sourceforge.net/projects/ijbswa
+ 58. http://ijbswa.sourceforge.net/
+ 59. http://i.j.b/
+ 60. http://www.junkbusters.com/ht/en/cookies.html
+ 61. http://www.waldherr.org/junkbuster/
+ 62. http://privacy.net/analyze/
+ 63. http://www.squid-cache.org/
+ 64. http://www.perldoc.com/perl5.6/pod/perlre.html
+
+ Hidden links:
+ 65. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1308
+ 66. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1316
+ 67. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1319
+ 68. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1322
+ 69. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1325
+ 70. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1330
+ 71. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1333
+ 72. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1336
+ 73. file://localhost/home/swa/sf/current/doc/source/tmp.html#AEN1342
projects / privoxy.git / blobdiff