By: Junkbuster Developers
-$Id: user-manual.sgml,v 1.32 2002/03/03 09:26:06 joergs Exp $
+$Id: user-manual.sgml,v 1.35 2002/03/05 00:17:27 hal9 Exp $
The user manual gives the users information on how to install and configure
Internet Junkbuster. Internet Junkbuster is an application that provides
2.5. Windows
2.6. Other
-3. Junkbuster Configuration
+3. Invoking and Configuring JunkBuster
- 3.1. The Main Configuration File
+ 3.1. Command Line Options
+ 3.2. The Main Configuration File
- 3.1.1. Defining Other Configuration Files
- 3.1.2. Other Configuration Options
- 3.1.3. Access Control List (ACL)
- 3.1.4. Forwarding
- 3.1.5. Windows GUI Options
+ 3.2.1. Defining Other Configuration Files
+ 3.2.2. Other Configuration Options
+ 3.2.3. Access Control List (ACL)
+ 3.2.4. Forwarding
+ 3.2.5. Windows GUI Options
- 3.2. The Actions File
+ 3.3. The Actions File
- 3.2.1. URL Domain and Path Syntax
- 3.2.2. Actions
- 3.2.3. Aliases
+ 3.3.1. URL Domain and Path Syntax
+ 3.3.2. Actions
+ 3.3.3. Aliases
- 3.3. The Filter File
- 3.4. Templates
+ 3.4. The Filter File
+ 3.5. Templates
4. Quickstart to Using Junkbuster
5. Contacting the Developers, Bug Reporting and Feature Requests
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
- /usr/src/redhat/SRPMS/junkbuster-2.9.10-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.10-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
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm
- /usr/src/packages/SRPMS/junkbuster-2.9.10-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.10-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
-------------------------------------------------------------------------------
-3. Junkbuster Configuration
+3. Invoking and Configuring JunkBuster
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
-------------------------------------------------------------------------------
-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.
+
+ * 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 initial keyword
-------------------------------------------------------------------------------
-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
-------------------------------------------------------------------------------
-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.
"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 your web browser,
+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").
+"8118").
-If you already have another service running on port 8000, or if you want to
+If you already have another service running on port 8118, or if you want to
serve requests from other machines (e.g. on your local network) as well, you
will need to override the default. The syntax is "listen-address
[<ip-address>]:<port>". If you leave out the IP address, junkbuster will bind
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).
+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 1 is informative
-------------------------------------------------------------------------------
-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 note the
-------------------------------------------------------------------------------
-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 accessing specific
isp-b.com. host-a can run a Junkbuster proxy with 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
# 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
-------------------------------------------------------------------------------
-3.1.5. Windows GUI Options
+3.2.5. Windows GUI Options
Junkbuster has a number of options specific to the Windows GUI interface:
-------------------------------------------------------------------------------
-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 various other
-------------------------------------------------------------------------------
-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 part, the "/" can be
-------------------------------------------------------------------------------
-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 braces (e.g.
-------------------------------------------------------------------------------
-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 built-in "actions".
-------------------------------------------------------------------------------
-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 directory. In this
-------------------------------------------------------------------------------
-3.4. Templates
+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
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 ->
+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
+and fill in the appropriate info (Address: localhost, Port: 8118). Include if
HTTPS proxy support too.
The included default configuration files should give a reasonable starting
If a particular site shows problems loading properly, try adding it to 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 compatibility. 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.
projects / privoxy.git / commitdiff