From 5afb9b8dc315563b6865becea1a14c25ed238f6d Mon Sep 17 00:00:00 2001 From: hal9 Date: Sat, 9 Mar 2002 17:08:48 +0000 Subject: [PATCH] New section on Jon's actions file editor, and move some stuff around. --- doc/source/user-manual.sgml | 250 +++++++++++++++++++++++------------- 1 file changed, 161 insertions(+), 89 deletions(-) diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index ecca5029..1db65a5d 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -6,7 +6,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.42 2002/03/07 18:16:55 swa Exp $ + $Id: user-manual.sgml,v 1.43 2002/03/08 00:47:32 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge IJBSWA team. http://ijbswa.sourceforge.net @@ -28,7 +28,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.42 2002/03/07 18:16:55 swa Exp $ +$Id: user-manual.sgml,v 1.43 2002/03/08 00:47:32 hal9 Exp $ @@ -447,7 +447,74 @@ configuration section below. HB.) -Invoking and Configuring JunkBuster +JunkBuster Configuration + + All JunkBuster configuration is kept + in text files. These files can be edited with a text editor. + Many important aspects of JunkBuster can + also be controlled easily with a web browser. + + + + + + + +Controlling Junkbuster with Your Web Browser + + JunkBuster can be reached by the special + URL http://i.j.b/ (or alternately + http://ijbswa.sourceforge.net/config/, + which is an internal page. You will see the following section: + + + + + + +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 + + + + + + This should be self-explanatory. Note the last item is an editor for the + actions list, which is where much of the ad, banner, cookie, + and URL blocking magic is configured as well as other advanced features of + Junkbuster. This is an easy way to adjust various + aspects of Junkbuster configuration. The actions + file, and other configuration files, are explained in detail below. + Junkbuster will automatically detect any changes + to these files. + + + + Toggle JunkBuster On or Off 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 JunkBuster + causing the problem or not. Junkbuster continues + to run as a proxy in this case, but all filtering is disabled. + + + + + + + + + + + + + +Configuration Files Overview For Unix, *BSD and Linux, all configuration files are located in /etc/junkbuster/ by default. For MS Windows, OS/2, and @@ -480,8 +547,7 @@ configuration section below. HB.) 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. (Other actions + url="http://i.j.b">http://i.j.b. (Other actions files are included as well with differing levels of filtering and blocking, e.g. ijb-basic.action.) @@ -514,89 +580,8 @@ configuration section below. HB.) Also, what constitutes a default setting, may change, so please check all your configuration files on important issues. - - - - - - -Command Line Options - - JunkBuster may be invoked with the following - command-line options: - - - - - - - - --version - - - Print version info and exit, Unix only. - - - - - --help - - - Print a short usage info and exit, Unix only. - - - - - --no-daemon - - - Don't become a daemon, i.e. don't fork and become process group - leader, don't detach from controlling tty. Unix only. - - - - - --pidfile FILE - - - - On startup, write the process ID to FILE. Delete the - FILE on exit. Failiure to create or delete the - FILE is non-fatal. If no FILE - option is given, no PID file will be used. Unix only. - - - - - --user USER - - - - After (optionally) writing the PID file, assume the user ID of - USER. Exit if the privileges are not sufficient to do - so. Unix only. - - - - - configfile - - - If no configfile is included on the command line, - JunkBuster will look for a file named - config in the current directory (except on Win32 - where it will look for config.txt instead). Specify - full path to avoid confusion. - - - - - - - - @@ -2874,7 +2859,7 @@ Removed references to Win32. HB 09/23/01 When Junkbuster displays one of its internal pages, such as a 404 Not Found error page, it uses the appropriate template. - On Linux, BSD, and Unix, these are locate in + On Linux, BSD, and Unix, these are located in /etc/junkbuster/templates by default. These may be customized, if desired. @@ -2891,8 +2876,8 @@ Removed references to Win32. HB 09/23/01 Quickstart to Using Junkbuster Install package, then run and enjoy! JunkBuster - accepts only one command line option -- the configuration file to be - used. Example Unix startup command: + is typically started by specifying the main configuration file to be + used on the command line. Example Unix startup command: @@ -2998,10 +2983,94 @@ For RedHat: /etc/rc.d/init.d/junkbuster start the developers (see below). + + + + + +Command Line Options + + JunkBuster may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + JunkBuster will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + + + + + + + Contacting the Developers, Bug Reporting and Feature Requests @@ -3394,6 +3463,9 @@ For any other issues, feel free to use the