This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.15 2001/10/14 23:46:24 hal9 Exp $
+ $Id: user-manual.sgml,v 1.22 2001/11/05 23:57:51 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
IJBSWA team. http://ijbswa.sourceforge.net
<artheader>
<title>Junkbuster User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.15 2001/10/14 23:46:24 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.22 2001/11/05 23:57:51 hal9 Exp $</pubdate>
<authorgroup>
<author>
<listitem>
<para>
- Modularized configuration that will allow for system wide settings, and
- individual user settings.
+ A browser based configuration utility (WIP at
+ <ulink url="http://i.j.b">http://i.j.b</ulink>).
</para>
</listitem>
<listitem>
<para>
- A browser based GUI configuration utility (not finished).
+ Modularized configuration that will allow for system wide settings, and
+ individual user settings. (not implemented yet)
</para>
</listitem>
<listitem>
<para>
- Partial support for HTTP/1.1.
+ Support for HTTP/1.1 (partially implemented at this point).
</para>
</listitem>
</itemizedlist>
</para>
+<para>
+ In addition, the configuration is more versatile overall.
+</para>
+
</sect2>
</sect1>
<para>
<screen>
- tar zxvf ijb_source_2.9*
- cd ijb_source_2.9*
+ tar xzvf ijb_source_* [.tgz or .tar.gz]
+ cd ijb_source_2.9.9_alpha
</screen>
</para>
</para>
<para>
- Then, in either case, to build from source:
+ Then, in either case, to build from tarball/CVS source:
</para>
<para>
<screen>
- ./configure
- make
- su
- make install
+ ./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)
</screen>
</para>
<para>
<screen>
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make redhat-dist
</screen>
<para>
<screen>
+ autoheader [suggested for CVS source]
+ autoconf [suggested for CVS source]
./configure
make suse-dist
</screen>
</para>
<para>
- /usr/src/suse/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
</para>
<para>
- /usr/src/suse/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.9-1.src.rpm
</para>
<para>
<para>
<screen>
- rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
</screen>
</para>
<listitem>
<para>
The main configuration file is named <filename>config</filename>
- on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
+ on Linux, Unix, BSD, and OS/2, and <filename>config.txt</filename> on
Windows. On Amiga, it is
<filename>AmiTCP:db/junkbuster/config</filename>.
</para>
<listitem>
<para>
- The <filename>actionsfile</filename> file is used to define various
- actions relating to images, banners, pop-ups, banners and cookies.
+ The <filename>ijb.action</filename> file is used to define various
+ <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.)
</para>
</listitem>
</para>
<para>
- <filename>actionsfile</filename> and <filename>re_filterfile</filename>
+ <filename>ijb.action</filename> and <filename>re_filterfile</filename>
can use Perl style regular expressions for maximum flexibility. All files use
the <quote><literal>#</literal></quote> character to denote a comment. Such
lines are not processed by <application>Junkbuster</application>. After
for the changes to take effect.
</para>
+<para>
+ 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 <quote>default</quote> setting, may change, so
+ please check all your configuration files on important issues.
+</para>
<!-- ~~~~~ New section ~~~~~ -->
<title>The Main Configuration File</title>
<para>
Again, the main configuration file is named <filename>config</filename> on
- Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
+ Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> 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:
</para>
<para>
- The <quote><literal>#</literal></quote> indicates a comment. Any part of a
+ A <quote><literal>#</literal></quote> indicates a comment. Any part of a
line following a <quote><literal>#</literal></quote> is ignored, except if
the <quote><literal>#</literal></quote> is preceded by a
<quote><literal>\</literal></quote>.
<para>
There are various aspects of <application>Junkbuster</application> behavior
- that can be adjusted.
+ that can be tuned.
</para>
</para>
<para>
- The <quote>actionsfile</quote> contains patterns to specify the actions to
+ 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 filtered. 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
- <quote>tinygif</quote>). The syntax of this file is explained in detail
- <link linkend="actionsfile">below</link>.
+ 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>.
</para>
<para>
<literal>
<MSGText>
<literallayout>
- <emphasis>actionsfile actionsfile</emphasis>
+ <emphasis>actionsfile ijb.action</emphasis>
</literallayout>
</MSGText>
</literal>
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
- out the IP adress, <application>junkbuster</application> will bind to all
+ out the IP address, <application>junkbuster</application> 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
- <quote>aclfile</quote> above).
+ Internet. In that case, consider using access control lists (acl's) (see
+ <quote>aclfile</quote> above), or a firewall.
</para>
<para>
<para>
The Windows version of <application>Junkbuster</application> puts an icon in
- the system tray, which allows you to change this option without having to
- edit this file. If you right-click on that icon (or select the
- <quote>Options</quote> menu), one choice is <quote>Enable</quote>. Clicking
- on enable toggles <application>Junkbuster</application> on and off. This is
- useful if you want to temporarily disable
- <application>Junkbuster</application>, e.g., to access a site that requires
- cookies which you normally have blocked.
+ the system tray, which also allows you to change this option. If you
+ right-click on that icon (or select the <quote>Options</quote> menu), one
+ choice is <quote>Enable</quote>. Clicking on enable toggles
+ <application>Junkbuster</application> on and off. This is useful if you want
+ to temporarily disable <application>Junkbuster</application>, 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 <application>Junkbuster</application>
+ internal address of <ulink url="http://i.j.b./">http://i.j.b./</ulink> on
+ any platform.
</para>
<para>
<quote>toggle 1</quote> means <application>Junkbuster</application> runs
normally, <quote>toggle 0</quote> means that
<application>Junkbuster</application> becomes a non-anonymizing non-blocking
- proxy. Default: 1.
+ proxy. Default: 1 (on).
</para>
<para>
</literal>
</para>
+<para>
+ For content filtering, i.e. the <quote>+filter</quote> and
+ <quote>+deanimate-gif</quote> actions, it is neccessary 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>
+ The <application>buffer-limit</application> 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 the client unfiltered and no further attempt to
+ filter the rest of it is made. Remember that there may multiple threads
+ running, which might require increasing the <quote>buffer-limit</quote>
+ Kbytes <emphasis>each</emphasis>, unless you have enabled
+ <quote>single-threaded</quote> above.
+</para>
+
+<para>
+ <literal>
+ <MSGText>
+ <literallayout>
+ <emphasis>buffer-limit 4069</emphasis>
+ </literallayout>
+ </MSGText>
+ </literal>
+</para>
+
+<para>
+ To enable the web-based <filename>ijb.action</filename> file editor set
+ <application>enable-edit-actions</application> to 1, or 0 to disable. Note
+ that you must have compiled <application>JunkBuster</application> with
+ support for this feature, otherwise this option has no effect. This
+ internal page can be reached at <ulink
+ url="http://i.j.b./">http://i.j.b./</ulink>.
+ </para>
+
+<para>
+ 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 probably want to disable this. Default: enabled.
+</para>
+
+<para>
+ <literal>
+ <MSGText>
+ <literallayout>
+ <emphasis>enable-edit-actions 1</emphasis>
+ </literallayout>
+ </MSGText>
+ </literal>
+</para>
+
+<para>
+ Allow <application>JunkBuster</application> to be toggled on and off
+ remotely, using your web browser. Set <quote>enable-remote-toggle</quote>to
+ 1 to enable, and 0 to disable. Note that you must have compiled
+ <application>JunkBuster</application> with support for this feature,
+ otherwise this option has no effect.
+</para>
+
+<para>
+ Security note: If this is enabled, anyone who can use the proxy can toggle
+ it on or off (see <ulink url="http://i.j.b./">http://i.j.b./</ulink>), and
+ their changes will affect all users. For shared proxies, you probably want to
+ disable this. Default: enabled.
+</para>
+
+<para>
+ <literal>
+ <MSGText>
+ <literallayout>
+ <emphasis>enable-remote-toggle 1</emphasis>
+ </literallayout>
+ </MSGText>
+ </literal>
+</para>
+
</sect3>
<!-- ~ End section ~ -->
This feature allows chaining of HTTP requests via multiple proxies.
It can be used to better protect privacy and confidentiality when
accessing specific domains by routing requests to those domains
- to a special purpose filtering proxy such as lpwa.com.
+ to a special purpose filtering proxy such as lpwa.com. Or to use
+ a caching proxy to speed up browsing.
</para>
<para>
</para>
<para>
- Also, we're told they insist on getting cookies and JavaScript, so you need
- to add home.com to the cookie file. We consider JavaScript a security risk.
+ 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.
</para>
<literal>
<MSGText>
<literallayout>
- <emphasis>forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
+ <emphasis>forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
<emphasis>forward my_company.com .</emphasis>
</literallayout>
</MSGText>
<literal>
<MSGText>
<literallayout>
- <emphasis>forward_socks4a .* . firewall.my_company.com:1080</emphasis>
+ <emphasis>forward-socks4a .* . firewall.my_company.com:1080</emphasis>
</literallayout>
</MSGText>
</literal>
<title>The Actions File</title>
<para>
- The <quote>actionsfile</quote> is used to define what actions
+ The <quote>ijb.action</quote> file (formerly
+ <filename>actionsfile</filename>) is used to define what actions
<application>Junkbuster</application> 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 <filename>actionsfile</filename>.
+ or rejected, or accepted only during the current browser session (i.e.
+ not written to disk).
</para>
<para>
url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
</para>
+<para>
+ The actions file can be edited with a browser by loading
+ <ulink url="http://i.j.b">http://i.j.b</ulink>, and then select
+ <quote>Edit Actions</quote>.
+</para>
+
<para>
There are four types of lines in this file: comments (begin with a
<quote>#</quote> character), actions, aliases and patterns, all of which are
- explained below.
+ explained below, as well as the configuration file syntax that
+ <application>Junkbuster</application> understands.
+
</para>
So in this case <application>JunkBuster</application> 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 <filename>actionsfile</filename> file will
+ provided default <filename>ijb.action</filename> file will
give a good starting point).
</para>
</para>
</listitem>
+ <listitem>
+ <para>
+ If the website sets cookies, <quote>no-cookies-keep</quote> 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.
+ </para>
+ <para>
+ <literal>
+ <MSGText>
+ <literallayout>
+ <emphasis>+no-cookies-keep</emphasis>
+ </literallayout>
+ </MSGText>
+ </literal>
+ </para>
+ </listitem>
+
<listitem>
<para>
Prevent the website from reading cookies:
<literal>
<MSGText>
<literallayout>
- # 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
</literallayout>
<quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
<quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
<quote>-</quote>. Alias names are not case sensitive, and
- <emphasis>must be defined before anything</emphasis> else in
- <filename>actionsfile</filename>! And there can only be one set of
- <quote>aliases</quote> of defined.
+ <emphasis>must be defined before anything</emphasis> else in the
+ <filename>ijb.action</filename>file ! And there can only be one set of
+ <quote>aliases</quote> defined.
</para>
<para>
<para>
<screen>
- # /usr/sbin/junkbuster /etc/junkbuster/config &
+ # /usr/sbin/junkbuster /etc/junkbuster/config
</screen>
</para>
+<para>
+ An init script is provided for SuSE and Redhat.
+</para>
+
+<para>
+For for SuSE: /etc/rc.d/junkbuster start
+</para>
+
+<para>
+For RedHat: /etc/rc.d/init.d/junkbuster start
+</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>junkbstr.txt</filename>. If no file is specified
+ 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 8000. 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.
+ Be sure your browser is set to use the proxy which is by default at
+ localhost, port 8000. 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.
</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 cookies, and add these to
- <filename>actionsfile</filename> 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
- <filename>actionsfile</filename> and disable this feature. If you use more
- than one browser, it would make more sense to let
+ want to keep an eye out for sites that require persistant 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
+ need to edit <filename>ijb.action</filename> and disable this feature. If you
+ use more than one browser, it would make more sense to let
<application>Junkbuster</application> handle this. In which case, the
browser(s) should be set to accept all cookies.
</para>
<para>
If a particular site shows problems loading properly, try adding it
to the <literal>{fragile}</literal> section of
- <filename>actionsfile</filename>. This will turn off most actions for
+ <filename>ijb.action</filename>. This will turn off most actions for
this site.
</para>
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
- <filename>actionsfile</filename>.
+ <filename>ijb.action</filename>.
</para>
<para>
After running <application>Junkbuster</application> 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.
+ be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
+ can be adjusted by pointing your browser to
+ <ulink url="http://i.j.b./">http://i.j.b./</ulink>,
+ and then follow the link to <quote>edit the actions list</quote>.
+ (This is an internal page and does not require Internet access.)
+</para>
+
+<para>
+ In fact, various aspects of <application>Junkbuster</application>
+ configuration can be viewed from this page, including
+ current configuration parameters, source code version numbers,
+ the browser's request headers, and <quote>actions</quote> that apply
+ to a given URL. In addition to the <filename>ijb.action</filename> file
+ editor mentioned above, <application>Junkbuster</application> can also
+ be turned <quote>on</quote> and <quote>off</quote> from this page.
</para>
<para>
</simplelist>
<simplelist>
<member>
- <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+ <ulink url="http://i.j.b./">http://i.j.b./</ulink>
</member>
</simplelist>
<simplelist>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.22 2001/11/05 23:57:51 hal9
+ Minor update for startup now daemon mode.
+
+ Revision 1.21 2001/10/31 21:11:03 hal9
+ Correct 2 minor errors
+
+ Revision 1.18 2001/10/24 18:45:26 hal9
+ *** empty log message ***
+
+ Revision 1.17 2001/10/24 17:10:55 hal9
+ Catching up with Jon's recent work, and a few other things.
+
+ Revision 1.16 2001/10/21 17:19:21 swa
+ wrong url in documentation
+
Revision 1.15 2001/10/14 23:46:24 hal9
Various minor changes. Fleshed out SEE ALSO section.