This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.28 2002/02/24 14:34:24 jongfoster Exp $
+ $Id: user-manual.sgml,v 1.46 2002/03/10 00:51:08 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
IJBSWA team. http://ijbswa.sourceforge.net
-->
<!--
-Sun 09/23/01 08:53:31 PM
+Sat 03/02/02 04:53:47 PM
-This is an unfinished, rough draft. Anyone reading this, believe let me
-know errors!!!!! Stefan, especially you!
+This should be ready for BETA release.
Hal Burgiss <hal@foobox.net>
-->
<artheader>
<title>Junkbuster User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.28 2002/02/24 14:34:24 jongfoster Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.46 2002/03/10 00:51:08 hal9 Exp $</pubdate>
<authorgroup>
<author>
<abstract>
<para>
- 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
<application>Internet Junkbuster</application>. <application>Internet
- Junkbuster</application> is an application that provides privacy and
- security to users of the World Wide Web.
+ Junkbuster</application> 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. <application>Internet
+ Junkbuster</application> has application for both stand-alone systems and
+ multi-user networks.
</para>
<para>
You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
</para>
- <para>
- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
- </para>
+<!-- <para> -->
+<!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
+<!-- </para> -->
</abstract>
</artheader>
<sect1 id="introduction"><title>Introduction</title>
<para>
<application>Internet Junkbuster</application> 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. <application>Junkbuster</application> has a
- very flexible configuration and can be customized to suit individual needs
- and tastes. <application>Internet Junkbuster</application> 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.
+ <application>Junkbuster</application> has a very flexible configuration and
+ can be customized to suit individual needs and tastes. <application>Internet
+ Junkbuster</application> has application for both stand-alone systems and
+ multi-user networks.
</para>
<para>
- This documentation is included with the current development version of
- <application>Internet Junkbuster</application> and is incomplete at this
+ This documentation is included with the current BETA version of
+ <application>Internet Junkbuster</application> 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 <quote>soon</quote> ;-)
</para>
<para>
- 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 <emphasis>are</emphasis> 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 <emphasis>may be</emphasis> bugs, though hopefully
+ not many!
</para>
<listitem>
<para>
- A browser based configuration utility (WIP at
- <ulink url="http://i.j.b">http://i.j.b</ulink>).
+ Integrated browser based configuration and control utility (<ulink
+ url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
+ and filter effects.
</para>
</listitem>
<listitem>
<para>
- Blocking of annoying pop-up browser windows (previously available as a
- patch).
+ Blocking of annoying pop-up browser windows.
</para>
</listitem>
<listitem>
<para>
- Support for HTTP/1.1 (partially implemented at this point).
+ HTTP/1.1 compliant (most, but not all 1.1 features are supported).
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
<listitem>
<para>
- Web page content filtering.
+ GIF de-animation.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Web page content filtering (removes banners based on size,
+ invisible <quote>web-bugs</quote>, JavaScript, pop-ups, status bar abuse,
+ etc.)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Bypass many click-tracking scripts (avoids script redirection).
+
</para>
</listitem>
<listitem>
<para>
- Multi-threaded.
+ Multi-threaded (POSIX and native threads).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Auto-detection and re-reading of config file changes.
</para>
</listitem>
<listitem>
<para>
- Auto-detection of config file changes.
+ User-customizable HTML templates (e.g. 404 error page).
</para>
</listitem>
+ <listitem>
+ <para>
+ Improved cookie management features (e.g. session based cookies).
+ </para>
+</listitem>
- </itemizedlist>
-</para>
+ <listitem>
+ <para>
+ 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.
+
+ </para>
+ </listitem>
-<para>
- In addition, the configuration is much more versatile overall.
+ <listitem>
+ <para>
+ In addition, the configuration is much more powerful and versatile over-all.
+ </para>
+</listitem>
+
+ </itemizedlist>
</para>
</sect2>
<application>Junkbuster</application> is available as raw source code, or
pre-compiled binaries. See the <ulink
url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
- for current release info. <application>Junkbuster</application> is also available
- via <ulink
+ for binaries and current release info. <application>Junkbuster</application>
+
is also available via <ulink
url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
This is the recommended approach at this time. But please be aware that CVS
is constantly changing, and it may break in mysterious ways.
<para>
<screen>
tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.10_beta
+ cd ijb_source_2.9.11_beta
</screen>
</para>
</para>
<para>
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
+ /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- 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
</screen>
</para>
</para>
<para>
- /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
</para>
<para>
- /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.11-1.src.rpm
</para>
<para>
<para>
<screen>
- 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
</screen>
</para>
<screen>
cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
- cd current
</screen>
This will create a directory named os2setup/, which will contain the
<filename>Makefile.vac</filename> makefile and <filename>os2build.cmd</filename>
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="configuration"><title>Junkbuster Configuration</title>
+<sect1 id="configuration"><title>JunkBuster Configuration</title>
+ <para>
+ All <application>JunkBuster</application> configuration is kept
+ in text files. These files can be edited with a text editor.
+ Many important aspects of <application>JunkBuster</application> can
+ also be controlled easily with a web browser.
+
+ </para>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Controlling Junkbuster with Your Web Browser</title>
+<para>
+ <application>JunkBuster</application> can be reached by the special
+ URL <ulink url="http://i.j.b/">http://i.j.b/</ulink> (or alternately
+ <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>,
+ which is an internal page. You will see the following section:
+
+</para>
+
+<para>
+ <screen>
+
+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
+
+ </screen>
+</para>
+
+<para>
+ This should be self-explanatory. Note the last item is an editor for the
+ <quote>actions list</quote>, which is where much of the ad, banner, cookie,
+ and URL blocking magic is configured as well as other advanced features of
+ <application>Junkbuster</application>. This is an easy way to adjust various
+ aspects of <application>Junkbuster</application> configuration. The actions
+ file, and other configuration files, are explained in detail below.
+ <application>Junkbuster</application> will automatically detect any changes
+ to these files.
+</para>
+
+<para>
+ <quote>Toggle JunkBuster On or Off</quote> 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 <application>JunkBuster</application>
+ causing the problem or not. <application>Junkbuster</application> continues
+ to run as a proxy in this case, but all filtering is disabled.
+
+</para>
+
+</sect2>
+
+<!-- ~ End section ~ -->
+
+
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Configuration Files Overview</title>
<para>
- For Unix, *BSD and Linux, all configuraton files are located in
- <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
- these are all in the same directory as the
+ For Unix, *BSD and Linux, all configuration files are located in
+ <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
+ AmigaOS these are all in the same directory as the
<application>Junkbuster</application> executable. The name and number of
configuration files has changed from previous versions, and is subject to
change as development progresses.
<listitem>
<para>
The main configuration file is named <filename>config</filename>
- on Linux, Unix, BSD, and OS/2, and <filename>config.txt</filename> on
- Windows. On Amiga, it is
- <filename>AmiTCP:db/junkbuster/config</filename>.
+ on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
+ on Windows.
</para>
</listitem>
<quote>actions</quote> 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 <ulink
- url="http://i.j.b">http://i.j.b</ulink>. This is the easiest method of
- configuring actions. (Still under active development. Other actions
+ url="http://i.j.b">http://i.j.b</ulink>. (Other actions
files are included as well with differing levels of filtering
and blocking, e.g. <filename>ijb-basic.action</filename>.)
</para>
Also, what constitutes a <quote>default</quote> setting, may change, so
please check all your configuration files on important issues.
</para>
+</sect2>
+
<!-- ~~~~~ New section ~~~~~ -->
</para>
<para>
- On <application>Windows</application>, <application>Junkbuster</application>
- looks for these files in the same directory as the executable. On Unix and
- OS/2, <application>Junkbuster</application> looks for these files in the current
- working directory. In either case, an absolute path name can be used to
+ On <application>Windows</application> and <application>AmigaOS</application>,
+ <application>Junkbuster</application> looks for these files in the same
+ directory as the executable. On Unix and OS/2,
+ <application>Junkbuster</application> looks for these files in the current
+ working directory. In either case, an absolute path name can be used to
avoid problems.
</para>
<para>
- 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 <quote>confdir</quote>.
For now, only <filename>confdir/templates</filename> is used for storing HTML
templates for CGI results.
The <quote>ijb.action</quote> 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 <quote>re_filterfile</quote> specified. No sites are blocked. An
- empty image is displayed for filtered ads and other images (formerly
- <quote>tinygif</quote>). The syntax of this file is explained in detail <link
- linkend="actionsfile">below</link>.
+ are not saved to disk). Pop-ups are disabled for all sites. All sites are
+ filtered if <quote>re_filterfile</quote> specified according to the
+ contents of <quote>re_filterfile</quote>. No sites are blocked. The
+ JunkBuster logo is displayed for filtered ads and other images . The syntax
+ of this file is explained in detail <link
+ linkend="actionsfile">below</link>.
</para>
<para>
<para>
The <quote>re_filterfile</quote> 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 <quote>Microsoft</quote> with
<quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
content modification, or whatever the developers are playing with :-/
</para>
+<para>
+ 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.
+
+</para>
+
<para>
<literal>
<msgtext>
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
<quote>trustfile</quote>. 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.
</para>
</para>
<para>
- 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
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.
</para>
<para>
<para>
<quote>Listen-address</quote> specifies the address and port where
<application>Junkbuster</application> 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 <quote>localhost</quote> and the
- port as <quote>8000</quote>).
+ port as <quote>8118</quote>).
</para>
<para>
- 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
<quote>listen-address [<ip-address>]:<port></quote>. If you leave
<literal>
<msgtext>
<literallayout>
- <emphasis>listen-address 192.168.0.1:8000</emphasis>
+ <emphasis>listen-address 192.168.0.1:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<literal>
<msgtext>
<literallayout>
- <emphasis>listen-address :8000</emphasis>
+ <emphasis>listen-address :8118</emphasis>
</literallayout>
</msgtext>
</literal>
<para>
If you do this, consider using ACLs (see <quote>aclfile</quote> 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).
</para>
<para>
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
</literallayout>
<para>
For content filtering, i.e. the <quote>+filter</quote> and
- <quote>+deanimate-gif</quote> actions, it is neccessary that
+ <quote>+deanimate-gif</quote> actions, it is necessary that
<application>Junkbuster</application> 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.
</para>
<para>
- (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.)
</para>
<msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-b.com host-b:8000</emphasis>
+ <emphasis>forward isp-b.com host-b:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<msgtext>
<literallayout>
<emphasis>forward .* .</emphasis>
- <emphasis>forward isp-a.com host-a:8000</emphasis>
+ <emphasis>forward isp-a.com host-a:8118</emphasis>
</literallayout>
</msgtext>
</literal>
<literallayout>
# Define junkbuster as parent cache
<!-- per feedback from user...
- cache_peer 127.0.0.1 8000 parent 0 no-query
+ cache_peer 127.0.0.1 8118 parent 0 no-query
-->
- 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
</para>
<para>
- Additionally, there are wildcards that you can use in the domain names
- themselves. They work pretty similar to shell wildcards: <quote>*</quote>
+ Additionally, there are wild-cards that you can use in the domain names
+ themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
stands for zero or more arbitrary characters, <quote>?</quote> 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:
</para>
<para>
If <application>Junkbuster</application> was compiled with
<quote>pcre</quote> support (default), Perl compatible regular expressions
- can be used. See the <filename>pcre/docs/</filename> direcory or <quote>man
+ can be used. See the <filename>pcre/docs/</filename> directory or <quote>man
perlre</quote> (also available on <ulink
url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
for details. A brief discussion of regular expressions is in the
This will also shrink the images considerably (in bytes, not pixels!). If
the option <quote>first</quote> is given, the first frame of the animation
is used as the replacement. If <quote>last</quote> 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).
</para>
</para>
<para>
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
<listitem>
<para>
Decides what to do with URLs that end up tagged with <quote>{+block
- +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
- send a HTML <quote>blocked</quote> page, usually resulting in a
- <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
- send a <quote>JunkBuster</quote> image.
- <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
- And finally, <quote>+image-blocker{http://xyz.com}</quote> 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}</quote>, e.g an advertizement. There are five options.
+ <quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
+ usually resulting in a <quote>broken image</quote> icon.
+ <quote>+image-blocker{logo}</quote> will send a <quote>JunkBuster</quote>
+ logo image. <quote>+image-blocker{blank}</quote> will send a 1x1
+ transparent GIF image. And finally,
+ <quote>+image-blocker{http://xyz.com}</quote> 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.
+ <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern,
+ which scales better than the logo (which can get blocky if the browser
+ enlarges it too much).
</para>
<para>
<literal>
<literal>
<msgtext>
<literallayout>
- # 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 }
<sect2 id="filterfile">
<title>The Filter File</title>
<para>
- The filter file defines what filtering of web pages
- <application>Junkbuster</application> does. The default filter file is
- <filename>re_filterfile</filename>, located in the config directory. In this
- file, <emphasis>any document content</emphasis>, 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
+ <filename>re_filterfile</filename>, located in the config directory.
</para>
<para>
This file uses regular expressions to alter or remove any string in the
- target page. Some examples from the included default <filename>re_filterfile</filename>:
+ target page. The expressions can only operate on one line at a time .Some
+ examples from the included default <filename>re_filterfile</filename>:
</para>
<para>
<para>
When <application>Junkbuster</application> 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
+ On Linux, BSD, and Unix, these are located in
<filename>/etc/junkbuster/templates</filename> by default. These may be
customized, if desired.
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
<para>
- Install package, then run and enjoy! <application>Junbuster</application>
- accepts only one command line option -- the configuration file to be
- used. Example Unix startup command:
+ Install package, then run and enjoy! <application>JunkBuster</application>
+ is typically started by specifying the main configuration file to be
+ used on the command line. Example Unix startup command:
</para>
<para>
<para>
If no configuration file is specified on the command line,
<application>Junkbuster</application> will look for a file named
- <filename>config</filename> in the current directory. Except on Amiga where
- it will look for <filename>AmiTCP:db/junkbuster/config</filename> and Win32
- where it will try <filename>config.txt</filename>. If no file is specified
- on the command line and no default configuration file can be found,
+ <filename>config</filename> in the current directory. Except on Win32 where
+ it will try <filename>config.txt</filename>. If no file is specified on the
+ command line and no default configuration file can be found,
<application>Junkbuster</application> will fail to start.
</para>
<para>
Be sure your browser is set to use the proxy which is by default at
- localhost, port 8
000. With <application>Netscape</application> (and
+ localhost, port 8
118. With <application>Netscape</application> (and
<application>Mozilla</application>), this can be set under <literal>Edit
-> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
For <application>Internet Explorer</application>: <literal>Tools >
Internet Properties -> Connections -> LAN Setting</literal>. Then,
check <quote>Use Proxy</quote> 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.
</para>
<para>
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
<filename>ijb.action</filename> 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
</para>
<para>
- HTTP/1.1 support is not fully implemented. If browsers that
- support HTTP/1.1 (like <application>Mozilla</application> or recent versions
- of I.E.) experience problems, you might try to force HTTP/1.0 compatiblity.
- For Mozilla, look under <literal>Edit -> Preferences -> Debug ->
- Networking</literal>. Or set the <quote>+downgrade</quote> config option in
+ <application>Junkbuster</application> is HTTP/1.1 compliant, but not all 1.1
+ features are as yet implemented. If browsers that support HTTP/1.1 (like
+ <application>Mozilla</application> or recent versions of I.E.) experience
+ problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
+ under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
+ Or set the <quote>+downgrade</quote> config option in
<filename>ijb.action</filename>.
</para>
the developers (see below).
</para>
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+
+<sect2>
+<title>Command Line Options</title>
+<para>
+ <application>JunkBuster</application> may be invoked with the following
+ command-line options:
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>--version</emphasis>
+ </para>
+ <para>
+ Print version info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--help</emphasis>
+ </para>
+ <para>
+ Print a short usage info and exit, Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--no-daemon</emphasis>
+ </para>
+ <para>
+ Don't become a daemon, i.e. don't fork and become process group
+ leader, don't detach from controlling tty. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--pidfile FILE</emphasis>
+
+ </para>
+ <para>
+ On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
+ <emphasis>FILE</emphasis> on exit. Failiure to create or delete the
+ <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
+ option is given, no PID file will be used. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>--user USER[.GROUP]</emphasis>
+
+ </para>
+ <para>
+ After (optionally) writing the PID file, assume the user ID of
+ <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
+ privileges are not sufficient to do so. Unix only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>configfile</emphasis>
+ </para>
+ <para>
+ If no <emphasis>configfile</emphasis> is included on the command line,
+ <application>JunkBuster</application> will look for a file named
+ <quote>config</quote> in the current directory (except on Win32
+ where it will look for <quote>config.txt</quote> instead). Specify
+ full path to avoid confusion.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+</sect2>
+
</sect1>
+<!-- ~ End section ~ -->
+
+
<!-- ~~~~~ New section ~~~~~ -->
-<sect1 id="contact"><title>Contact the Developers</title>
+
+<sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
+Requests</title>
<para>
-<!--
-To be filled. mention the support forums as the primary channel of
-communication (bugs, feature requests, etc.)
--->
- Feature requests and other questions should be posted to the <ulink
- url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
- request page</ulink> at SourceForge. There is also an archive there.
+We value your feedback. However, to provide you with the best support,
+please note:
+
+ <itemizedlist>
+
+ <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">Sourceforge support forum</ulink> to get
+ help.</para></listitem>
+
+ <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge bug
+ forum</ulink>.
+Make sure that the bug has not already been submitted. Please try to
+verify that it is a <application>Junkbuster</application> 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.</para>
+</listitem>
+
+
+ <listitem><para>Submit feature requests only thru our <ulink
+ url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
+
+
+ </itemizedlist>
+
+</para>
+
+<para>
+For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
</para>
<para>
Archives are available here too.
</para>
-<para>
- Please report bugs, using the form at
- <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
- Please try to verify that it is a <application>Junkbuster</application> bug,
- and not a browser or site bug first. Also, check to make sure this is not
- already a known bug.
-</para>
-
</sect1>
<para>
<application>Junkbuster</application> was originally written by Anonymous
Coders and <ulink
- url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
+ url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
Corporation</ulink>, and was released as free open-source software under the
GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
Waldherr</ulink> made many improvements, and started the <ulink
url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> 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 ;-).
</para>
</sect2>
in various config files. Assuming support for <quote>pcre</quote> (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.
</para>
expression against another to see if it matches or not. One of the
<quote>expressions</quote> 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 <quote>metacharacters</quote> have special meanings and
+ characters combined with wild-cards, and other special characters, called
+ meta-characters. The <quote>meta-characters</quote> 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.
</para>
<para>
- 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 <command>dir</command> command in DOS.
<literal>*.*</literal> matches all filenames. The <quote>special</quote>
- 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 <literal>?</literal> to match just individual
characters. So <quote>dir file?.text</quote> would match
<quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
the following character should be taken literally. This is used where one of the
special characters (e.g. <quote>.</quote>) needs to be taken literally and
- not as a special metacharacter.
+ not as a special meta-character.
</member>
</simplelist>
<simplelist>
<member>
- <emphasis>()</emphasis> - pararentheses are used to group a sub-expression,
+ <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
</simplelist>
<para>
<emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
- a substitution. <quote>MicroSuck</quote> will replace any occurence of
+ a substitution. <quote>MicroSuck</quote> will replace any occurrence of
<quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
means ignore case. The <quote>(?!.com)</quote> means
the match should fail if <quote>microsoft</quote> is followed by
</sect2>
+<!-- ~ End section ~ -->
+
+
+<!-- ~~~~~ New section ~~~~~ -->
+<sect2>
+<title>JunkBuster's Internal Pages</title>
+
+<para>
+ Since <application>JunkBuster</application> proxies each requested
+ web page, it is easy for <application>JunkBuster</application> to
+ trap certain URLs. In this way, we can talk directly to
+ <application>JunkBuster</application>, and see how it is
+ configured, see how our rules are being applied, change these
+ rules and other configuration options, and even turn
+ <application>JunkBuster</application> off.
+
+</para>
+
+<para>
+ The URLs listed below are the special ones that allow direct access
+ to <application>JunkBuster</application>. Of course,
+ <application>JunkBuster</application> must be running to access these. If
+ not, you will get a friendly error message.
+
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Junkbuster main page:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+ </para>
+ </blockquote>
+ <para>
+ Alternately, this may be reached at <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
+ but this variation may not work as reliably as the above in some
+ configurations.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show information about the current configuration:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show the source code version numbers:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show the client's request headers:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show which actions apply to a URL and why:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Toggle JunkBuster on or off:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
+ </para>
+ </blockquote>
+ <para>
+ Short cuts. Turn off, then on:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/config/toggle?set=disable</ulink>
+ </para>
+ </blockquote>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=enable">http://ijbswa.sourceforge.net/config/toggle?set=enable</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ <listitem>
+ <para>
+ Edit the actions list file:
+ </para>
+ <blockquote>
+ <para>
+ <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
+ </para>
+ </blockquote>
+ </listitem>
+
+ </itemizedlist>
+</para>
+
+<para>
+ These may be bookmarked for quick reference.
+
+</para>
+
+</sect2>
+
</sect1>
<!--
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.46 2002/03/10 00:51:08 hal9
+ Added section on JB internal pages in Appendix.
+
+ Revision 1.45 2002/03/09 17:43:53 swa
+ more distros
+
+ Revision 1.44 2002/03/09 17:08:48 hal9
+ New section on Jon's actions file editor, and move some stuff around.
+
+ Revision 1.43 2002/03/08 00:47:32 hal9
+ Added imageblock{pattern}.
+
+ Revision 1.42 2002/03/07 18:16:55 swa
+ looks better
+
+ Revision 1.41 2002/03/07 16:46:43 hal9
+ Fix a few markup problems for jade.
+
+ Revision 1.40 2002/03/07 16:28:39 swa
+ provide correct feedback channels
+
+ Revision 1.39 2002/03/06 16:19:28 hal9
+ Note on perceived filtering slowdown per FR.
+
+ Revision 1.38 2002/03/05 23:55:14 hal9
+ Stupid I did it again. Double hyphen in comment breaks jade.
+
+ Revision 1.37 2002/03/05 23:53:49 hal9
+ jade barfs on '- -' embedded in comments. - -user option broke it.
+
+ Revision 1.36 2002/03/05 22:53:28 hal9
+ Add new - - user option.
+
+ Revision 1.35 2002/03/05 00:17:27 hal9
+ Added section on command line options.
+
+ Revision 1.34 2002/03/04 19:32:07 oes
+ Changed default port to 8118
+
+ Revision 1.33 2002/03/03 19:46:13 hal9
+ Emphasis on where/how to report bugs, etc
+
+ Revision 1.32 2002/03/03 09:26:06 joergs
+ AmigaOS changes, config is now loaded from PROGDIR: instead of
+ AmiTCP:db/junkbuster/ if no configuration file is specified on the
+ command line.
+
+ Revision 1.31 2002/03/02 22:45:52 david__schmidt
+ Just tweaking
+
+ Revision 1.30 2002/03/02 22:00:14 hal9
+ Updated 'New Features' list. Ran through spell-checker.
+
+ Revision 1.29 2002/03/02 20:34:07 david__schmidt
+ Update OS/2 build section
+
Revision 1.28 2002/02/24 14:34:24 jongfoster
Formatting changes. Now changing the doctype to DocBook XML 4.1
will work - no other changes are needed.
projects / privoxy.git / blobdiff