-output is user-manual Using catalogs: /etc/sgml/sgml-docbook-3.1.cat Using
-stylesheet: /usr/share/sgml/docbook/utils-0.6/docbook-utils.dsl#html Working
-on: /home/hal/junkbuster/current/doc/source/user-manual.sgml Junkbuster User Manual
+Junkbuster User Manual
By: Junkbuster Developers
-Abstract
-The user manual gives the users
-information on how to install and
-configure 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 http://
-ijbswa.sourceforge.net/user-manual/.
-
-Feel free to send a note to the
-developers at
-ijbswa-developers@lists.sourceforge.net
-.
-
- -----------------------------------------------------------
-Table of Contents
-Introduction
-Installation
-Junkbuster Configuration
-Quickstart to Using Junkbuster
-Contact the Developers
-Copyright and History
-See also
-Appendix
+$Id: user-manual.sgml,v 1.25 2002/01/09 18:20:30 hal9 Exp $
+
+The user manual gives the users information on how to install and configure
+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 http://
+ijbswa.sourceforge.net/user-manual/.
+
+Feel free to send a note to the developers at <
+ijbswa-developers@lists.sourceforge.net>.
-Introduction
+-------------------------------------------------------------------------------
+
+Table of Contents
+1. Introduction
+
+ 1.1. New Features
+
+2. Installation
+
+ 2.1. Source
+ 2.2. Red Hat
+ 2.3. SuSE
+ 2.4. OS/2
+ 2.5. Windows
+ 2.6. Other
+
+3. Junkbuster Configuration
+
+ 3.1. The Main Configuration File
+ 3.2. The Actions File
+ 3.3. The Filter File
+
+4. Quickstart to Using Junkbuster
+5. Contact the Developers
+6. Copyright and History
+
+ 6.1. License
+ 6.2. History
+
+7. See also
+8. Appendix
+
+ 8.1. Regular Expressions
+
+1. Introduction
Internet Junkbuster is a web proxy with advanced filtering capabilities for
protecting privacy, filtering web page content, managing cookies, controlling
-------------------------------------------------------------------------------
-New Features
+1.1. New Features
In addition to Junkbuster's traditional features of ad and banner blocking and
cookie management, this is a list of new features currently under development:
- * Modularized configuration that will allow for system wide settings, and
- individual user settings.
+ * A browser based configuration utility (WIP at http://i.j.b).
- * A browser based GUI configuration utility (not finished).
+ * 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).
- * Partial support for HTTP/1.1.
+ * Support for HTTP/1.1 (partially implemented at this point).
* Support for Perl Compatible Regular Expressions in the configuration files,
and generally a more sophisticated configuration syntax over previous
* Multi-threaded.
+In addition, the configuration is more versatile overall.
+
-------------------------------------------------------------------------------
-Installation
+2. Installation
Junkbuster is available as raw source code, or pre-compiled binaries. See the
Junkbuster Home Page for current release info. Junkbuster is also available via
-------------------------------------------------------------------------------
-Source
+2.1. Source
For gzipped tar archives, unpack the source:
- tar zxvf ijb_source_2.9*
- cd ijb_source_2.9*
+ tar xzvf ijb_source_* [.tgz or .tar.gz]
+ cd ijb_source_2.9.10_beta
For retrieving the current CVS sources, you'll need the CVS package installed
This will create a directory named current/, which will contain the source
tree.
-Then, in either case, to build from source:
+Then, in either case, to build from tarball/CVS source:
- autoconf #recommended for CVS source
- ./configure
- make
+ ./configure (--help to see options)
+ make (the make from gnu, gmake for *BSD)
su
- make 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.
-------------------------------------------------------------------------------
-Red Hat
+2.2. Red Hat
To build Redhat RPM packages, install source as above. Then:
- autoconf #recommended for CVS source
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make redhat-dist
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.10-1.i686.rpm
- /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/redhat/SRPMS/junkbuster-2.9.10-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.10-1.i686.rpm
This will place the Junkbuster configuration files in /etc/junkbuster/, and log
-------------------------------------------------------------------------------
-SuSE
+2.3. SuSE
To build SuSE RPM packages, install source as above. Then:
- autoconf #recommended for CVS source
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make suse-dist
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/suse/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
- /usr/src/suse/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
This will place the Junkbuster configuration files in /etc/junkbuster/, and log
-------------------------------------------------------------------------------
-OS/2
+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,
-------------------------------------------------------------------------------
-Windows
+2.5. Windows
Click-click. (I need help on this. Not a clue here. Also for configuration
section below. HB.)
-------------------------------------------------------------------------------
-Other
+2.6. Other
Some quick notes on other Operating Systems.
-For FreeBSD (and other *BSDs?), the build will need gmake instead of the
+For FreeBSD (and other *BSDs?), the build will require gmake instead of the
included make. gmake is available from http://www.gnu.org. The rest should be
the same as above for Linux/Unix.
-------------------------------------------------------------------------------
-Junkbuster Configuration
+3. Junkbuster Configuration
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
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 junkbustr.txt on Windows. On Amiga, it is AmiTCP:db/junkbuster/config.
+ and config.txt on Windows. On Amiga, it is AmiTCP:db/junkbuster/config.
- * The actionsfile file is used to define various actions relating to images,
- banners, pop-ups, banners and cookies. There is a CGI based editor for this
- file that can be accessed via http://i.j.b./. (Still under active
- development.)
+ * 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 http://i.j.b. This is
+ the easiest method of configuring actions. (Still under active development.
+ 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.
-actionsfile 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.
+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.
+
+While under development, the configuration content is subject to change. The
+below documentation may not be accurate by the time you read this. Also, what
+constitutes a "default" setting, may change, so please check all your
+configuration files on important issues.
-------------------------------------------------------------------------------
-The Main Configuration File
+3.1. The Main Configuration File
Again, the main configuration file is named config on Linux/Unix/BSD and OS/2,
-and junkbustr.txt on Windows. Configuration lines consist of an initial keyword
+and config.txt on Windows. Configuration lines consist of an initial keyword
followed by a list of values, all separated by whitespace (any number of spaces
or tabs). For example:
-------------------------------------------------------------------------------
-Defining Other Configuration Files
+3.1.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
Note that all file specifications below are relative to the above two
directories!
-The "actionsfile" contains patterns to specify the actions to apply to requests
-for each site. Default: Cookies to and from all destinations are filtered.
-Popups are disabled for all sites. All sites are filtered if re_filterfile
+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.
- actionsfile actionsfile
+ actionsfile ijb.action
The "re_filterfile" file contains content modification rules. These rules
-------------------------------------------------------------------------------
-Other Configuration Options
+3.1.2. Other Configuration Options
This part of the configuration file contains options that control how
Junkbuster operates.
If you already have another service running on port 8000, 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 adress, junkbuster will bind to
-all interfaces (addresses) on your machine and may become reachable from the
-internet. In that case, consider using access control lists (acl's) (see
-"aclfile" above).
+[<ip-address>]:<port>". If you leave out the IP address, junkbuster will bind
+to all interfaces (addresses) on your machine and may become reachable from the
+Internet. In that case, consider using access control lists (acl's) (see
+"aclfile" above), or a firewall.
For example, suppose you are running Junkbuster on a machine which has the
address 192.168.0.1 on your local private network (192.168.0.0) and has another
allows you to change this option. If you right-click on that icon (or select
the "Options" menu), one choice is "Enable". Clicking on enable toggles
Junkbuster on and off. This is useful if you want to temporarily disable
-Junkbuster, e.g., to access a site that requires cookies which you normally
-have blocked. This can also be toggled via a web browser at the Junkbuster
-internal address of http://i.j.b./ on any platform.
+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 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 (on).
For content filtering, i.e. the "+filter" and "+deanimate-gif" actions, it is
-neccessary that Junkbuster buffers up the entire document body. This can be
+neccessary 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.
+and wait for your RAM to exhaust. With nasty consequences.
The buffer-limit option lets you set the maximum size in Kbytes that each
buffer may use. When the documents buffer exceeds this size, it is flushed to
buffer-limit 4069
-To enable the web-based actionsfile editor set enable-edit-actions to 1, or 0
-to disable. Note that you must have compiled JunkBuster with support for this
+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 http://i.j.b./.
+at 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 shared proxies, you
effect.
Security note: If this is enabled, anyone who can use the proxy can toggle it
-on or off (see http://i.j.b./), and their changes will affect all users. For
+on or off (see 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
-------------------------------------------------------------------------------
-Access Control List (ACL)
+3.1.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 note the
-------------------------------------------------------------------------------
-Forwarding
+3.1.4. Forwarding
This feature allows chaining of HTTP requests via multiple proxies. It can be
used to better protect privacy and confidentiality when accessing specific
forward .* proxy:8080
-Also, we're told they insist on getting cookies and JavaScript, so you need to
+Also, we're told they insist on getting cookies and JavaScript, so you should
add home.com to the cookie file. We consider JavaScript a security risk. Java
need not be enabled.
everything else goes through Lucent's LPWA by way of the company's SOCKS
gateway to the Internet.
- forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080
+ forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080
forward my_company.com .
This is how you could set up a site that always uses SOCKS but no forwarders:
- forward_socks4a .* . firewall.my_company.com:1080
+ forward-socks4a .* . firewall.my_company.com:1080
An advanced example for network administrators:
-------------------------------------------------------------------------------
-Windows GUI Options
+3.1.5. Windows GUI Options
Junkbuster has a number of options specific to the Windows GUI interface:
-------------------------------------------------------------------------------
-The Actions File
+3.2. The Actions File
-The "actionsfile" is used to define what actions Junkbuster takes, and thus
-determines how images, cookies and various other aspects of HTTP content and
-transactions are handled. 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. The default file is in fact named actionsfile.
+The "ijb.action" file (formerly actionsfile) is used to define what actions
+Junkbuster takes, and thus determines how images, cookies and various other
+aspects of HTTP content and transactions are handled. 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). 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 http://i.j.b/show-url-info.
+The actions file can be edited with a browser by loading 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 below.
+character), actions, aliases and patterns, all of which are explained below, as
+well as the configuration file syntax that Junkbuster understands.
-------------------------------------------------------------------------------
-URL Domain and Path Syntax
+3.2.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 part, the "/" can be
-------------------------------------------------------------------------------
-Actions
+3.2.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 braces (e.g.
If nothing is specified in this file, no "actions" are taken. So in this case
JunkBuster would just be a normal, non-blocking, non-anonymizing proxy. You
must specifically enable the privacy and blocking features you need (although
-the provided default actionsfile file will give a good starting point).
+the provided default ijb.action file will give a good starting point).
Later defined actions always over-ride earlier ones. For multi-valued actions,
the actions are applied in the order they are specified.
+nocompression
+ * If the website sets cookies, "no-cookies-keep" will make sure they are
+ erased when you exit and restart your web browser. This makes profiling
+ cookies useless, but won't break sites which require cookies so that you
+ can log in for transactions. Default: on.
+
+ +no-cookies-keep
+
+
* Prevent the website from reading cookies:
+no-cookies-read
Turn off cookies by default, then allow a few through for specified sites:
- # Turn off all cookies
+ # Turn off all persistant cookies
{ +no-cookies-read }
{ +no-cookies-set }
+ # Allow cookies for this browser session ONLY
+ { +no-cookies-keep }
- # Execeptions to the above, sites that need cookies
+ # Execeptions to the above, sites that benefit from persistant cookies
{ -no-cookies-read }
{ -no-cookies-set }
+ { -no-cookies-keep }
.javasoft.com
.sun.com
.yahoo.com
.redhat.com
# Alternative way of saying the same thing
- {-no-cookies-set -no-cookies-read}
+ {-no-cookies-set -no-cookies-read -no-cookies-keep}
.sourceforge.net
.sf.net
-------------------------------------------------------------------------------
-Aliases
+3.2.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 built-in "actions".
Currently, an alias can contain any character except space, tab, "=", "{" or "}
". But please use only "a"- "z", "0"-"9", "+", and "-". Alias names are not
-case sensitive, and must be defined before anything else in actionsfile! And
-there can only be one set of "aliases" defined.
+case sensitive, and must be defined before anything else in the ijb.actionfile
+! And there can only be one set of "aliases" defined.
Now let's define a few aliases:
-------------------------------------------------------------------------------
-The Filter File
+3.3. 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
-------------------------------------------------------------------------------
-Quickstart to Using Junkbuster
+4. 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:
- # /usr/sbin/junkbuster /etc/junkbuster/config &
+ # /usr/sbin/junkbuster /etc/junkbuster/config
+An init script is provided for SuSE and Redhat.
+
+For for SuSE: /etc/rc.d/junkbuster start
+
+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 junkbstr.txt.
-If no file is specified on the command line and no default configuration file
-can be found, Junkbuster will fail to start.
+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.
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 under Edit ->
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 cookies, and add these to
-actionsfile as needed. By default, most of these will be blocked until you add
-them to the configuration. If you want the browser to handle this instead, you
-will need to edit actionsfile and disable this feature. If you use more than
-one browser, it would make more sense to let Junkbuster handle this. In which
-case, the browser(s) should be set to accept all cookies.
+want to keep an eye out for sites that require persistant 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 disable this feature. If you use more than one browser, it would make more
+sense to let Junkbuster handle this. In which case, the browser(s) should be
+set to accept all cookies.
If a particular site shows problems loading properly, try adding it to the
-{fragile} section of actionsfile. This will turn off most actions for this
-site.
+{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 actionsfile.
+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" (from
-actionsfile) can be adjusted by pointing your browser to 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.)
+There are many, many aspects that can be customized. "Actions" (as specified in
+ijb.action) can be adjusted by pointing your browser to 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.)
In fact, various aspects of Junkbuster configuration can be viewed from this
page, including current configuration parameters, source code version numbers,
the browser's request headers, and "actions" that apply to a given URL. In
-addition to the actionsfile editor mentioned above, Junkbuster can also be
+addition to the ijb.action file editor mentioned above, Junkbuster can also be
turned "on" and "off" from this page.
If you encounter problems, please verify it is a Junkbuster bug, by disabling
-------------------------------------------------------------------------------
-Contact the Developers
+5. Contact the Developers
Feature requests and other questions should be posted to the Feature request
page at SourceForge. There is also an archive there.
-------------------------------------------------------------------------------
-Copyright and History
+6. Copyright and History
-License
+6.1. License
Internet Junkbuster is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
-------------------------------------------------------------------------------
-History
+6.2. History
Junkbuster was originally written by Anonymous Coders and JunkBusters
Corporation, and was released as free open-source software under the GNU GPL.
-------------------------------------------------------------------------------
-See also
+7. See also
http://sourceforge.net/projects/ijbswa
http://ijbswa.sourceforge.net/
- http://i.j.b./
+ http://i.j.b/
http://www.junkbusters.com/ht/en/cookies.html
-------------------------------------------------------------------------------
-Appendix
+8. Appendix
-Regular Expressions
+8.1. Regular Expressions
Junkbuster can use "regular expressions" in various config files. Assuming
support for "pcre" (Perl Compatible Regular Expressions) is compiled in, which
More reading on Perl Compatible Regular expressions: http://www.perldoc.com/
perl5.6/pod/perlre.html
-Done.
projects / privoxy.git / blobdiff