junkbuster.1

   1 .\" Revised man page 10/13/01, for development version.\r
   2 .\" Hal Burgiss <hal@foobox.net> \r
   3 .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
   4 .\"\r
   5 .TH JUNKBUSTER 1 "v2.9.10 (beta) Date: 2001/12/30"\r
   6 \r
   7 .SH NAME\r
   8 \fBjunkbuster\fP\r
   9 - The\r
  10 Internet Junkbuster\r
  11 Proxy\r
  12 \s-2(TM)\s+2\r
  13 .SH SYNOPSIS\r
  14 \fBjunkbuster\fP\r
  15 \fI\&[config_file]\fP\r
  16 .br\r
  17 \fBjunkbstr.exe\fP\r
  18 \fI\&[config_file]\fP\r
  19 (Windows)\r
  20 .br\r
  21 .P\r
  22 If the configuration file is not specified on the command line,\r
  23 \fBJunkbuster\fP will look for a file named \fIconfig\fP in the \r
  24 current directory (except on Amiga where it will look for \r
  25 \fIAmiTCP:db/junkbuster/config\fP and Win32 where it will try \r
  26 \fIconfig.txt\fP).\r
  27 \r
  28 \r
  29 .SH DESCRIPTION\r
  30 \fBJunkbuster\fP\r
  31 is an instrumentable HTTP proxy that filters the \r
  32 \s-2HTTP\s0\r
  33 data stream between\r
  34 web servers and browsers.\r
  35 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web\r
  36 page content, manage access restrictions, and to discard such annoying Internet\r
  37 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your\r
  38 fancy.\r
  39 \r
  40 .SH INSTALLATION AND USE\r
  41 Browsers must be configured to use \r
  42 \fBJunkbuster\fP\r
  43 (the default is localhost, \r
  44 port 8000).\r
  45 To set the \r
  46 \s-2HTTP\s0\r
  47 proxy in Netscape and Mozilla,\r
  48 go through:\r
  49 \fB\&Edit\fP;\r
  50 \fB\&Preferences\fP;\r
  51 \fB\&Advanced\fP;\r
  52 \fB\&Proxies\fP;\r
  53 \fB\&Manual Proxy Configuration\fP;\r
  54 \fB\&View\fP.\r
  55 .P\r
  56 For Internet Explorer,\r
  57 go through:\r
  58 \fB\&Tools\fP;\r
  59 \fB\&Internet Properties\fP;\r
  60 \fB\&Connections\fP;\r
  61 \fB\&LAN Settings\fP.\r
  62 .P\r
  63 Set the HTTP proxy location for localhost, port 8000.\r
  64 The\r
  65 Secure (SSL) Proxy\" ijbfaq.html#security\r
  66 should also be set to the same values,\r
  67 otherwise\r
  68 \fB\&https:\fP\r
  69 \s-2URL\s0s\r
  70 won't be proxied.\r
  71 \r
  72 .SH CONFIGURATION\r
  73 All \fBJunkbuster\fP configuration is done via the various configuration \r
  74 files. The default configuration files are: \fIconfig\fP, \r
  75 \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. \r
  76 On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP \r
  77 by default. On Windows and OS/2, these files are in the same directory \r
  78 as the \fBJunkbuster\fP executable. \r
  79 .P\r
  80 The name and number of configuration files has changed from previous versions,\r
  81 and is subject to change as development progresses. In fact, the configuration\r
  82 itself is changed and much more sophisticated. See the user-manual for a brief\r
  83 explanation of all configuration options.\r
  84 .P\r
  85 \fBJunkbuster's\fP configuration parameters can be viewed at\r
  86 \fIhttp://i.j.b/\fP. This is an internal page. In\r
  87 addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can\r
  88 be toggled on/off.\r
  89 \r
  90 .SH "SAMPLE CONFIGURATION"\r
  91 .PP\r
  92 A brief example of what an \fIijb.action\fP configuration might look like:\r
  93 .PP\r
  94 .nf\r
  95 \r
  96 # Define a few useful custom aliases for later use\r
  97 {{alias}}\r
  98 # Don't accept cookies\r
  99 +no-cookies = +no-cookies-set +no-cookies-read\r
 100 # Do accept cookies\r
 101 -no-cookies = -no-cookies-set -no-cookies-read\r
 102 +imageblock = +block +image\r
 103 \r
 104 ## Default Policies (actions) ############################\r
 105 { \\\r
 106  -block \\\r
 107  -downgrade \\\r
 108  +fast-redirects \\\r
 109  +filter \\\r
 110  +no-compression \\\r
 111  +hide-forwarded \\\r
 112  +hide-from{block} \\\r
 113  +hide-referer{forge} \\\r
 114  -hide-user-agent \\\r
 115  -image \\\r
 116  +image-blocker{blank} \\\r
 117  +no-cookies-keep \\\r
 118  -no-cookies-read \\\r
 119  -no-cookies-set \\\r
 120  +no-popups \\\r
 121  -vanilla-wafer \\\r
 122  -wafer \\\r
 123 }\r
 124 /\r
 125 \r
 126 # Now set exceptions to the above defined policies #######\r
 127 \r
 128 # Sites where we want persistant cookies\r
 129 {-no-cookies -no-cookies-keep}\r
 130  .redhat.com\r
 131  .sun.com\r
 132  .yahoo.com\r
 133  .msdn.microsoft.com\r
 134 \r
 135 # This site requires cookies AND 'fast-redirects' on\r
 136 {-no-cookies -no-cookies-keep -fast-redirects}\r
 137  .nytimes.com\r
 138 \r
 139 # Add custom headers, and turn off filtering of page source\r
 140 {+add-header{X-Privacy: Yes please} #-add-header{*} \\\r
 141  +add-header{X-User-Tracking: No thanks!} -filter}\r
 142  privacy.net\r
 143 \r
 144 # Block, and treat these URLs as 'images'.\r
 145 {+imageblock}\r
 146  .adforce.imgis.com\r
 147  .ad.preferences.com/image.*\r
 148  .ads.web.aol.com\r
 149  .ad-adex3.flycast.com\r
 150  .ad.doubleclick.net\r
 151  .ln.doubleclick.net\r
 152  .ad.de.doubleclick.net\r
 153  /.*/count\\.cgi\\?.*df=\r
 154  194.221.183.22[1-7]\r
 155  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
 156 \r
 157 # Block any URLs that match these patterns\r
 158 {+block}\r
 159  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
 160  /.*/(plain|live|rotate)[-_.]?ads?/\r
 161  /.*/(sponsor)s?[0-9]?/\r
 162  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
 163  /.*/adbanners/\r
 164  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
 165  /.*/banners?/\r
 166  /.*/popupads/\r
 167  /.*/advert[0-9]+\\.jpg\r
 168  /ad_images/\r
 169  /.*/ads/\r
 170  /images/.*/.*_anim\\.gif\r
 171  /rotations/ \r
 172  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
 173  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
 174  .images.nytimes.com\r
 175  .images.yahoo.com/adv/\r
 176  /.*cnnstore\\.gif\r
 177 \r
 178 .fi\r
 179 .sp\r
 180 .PP\r
 181 See the comments in the configuration files themselves, or the user-manual \r
 182 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
 183 options.\r
 184 \r
 185 .SH "FILES"\r
 186 \fI/usr/sbin/junkbuster\fP\r
 187 .br\r
 188 \fI/etc/junkbuster/config\fP\r
 189 .br\r
 190 \fI/etc/junkbuster/ijb.action\fP\r
 191 .br\r
 192 \fI/etc/junkbuster/ijb-advanced.action\fP\r
 193 .br\r
 194 \fI/etc/junkbuster/ijb-basic.action\fP\r
 195 .br\r
 196 \fI/etc/junkbuster/ijb-intermediate.action\fP\r
 197 .br\r
 198 \fI/etc/junkbuster/re_filterfile\fP\r
 199 .br\r
 200 \fI/etc/junkbuster/trust\fP\r
 201 .br\r
 202 \fI/var/log/junkbuster/logfile\fP\r
 203 \r
 204 .P\r
 205 Various other files should be included, but may vary depending on platform \r
 206 and build configuration. More documentation should be included in the local\r
 207 documentation directory, though is not complete at this time.\r
 208 \r
 209 .SH SIGNALS\r
 210 \fBJunkbuster\fP use the signal \fISIGHUP\fP (see kill -l) to reload all configuration\r
 211 files (see CONFIGURATION). This includes the re-open of the logfiles\r
 212 (logfile and jarfile) eg. used\r
 213 after rotation of the logfiles by logrotate.\r
 214 The \fISIGHUP\fP behavior is only for UNIX like OS'.\r
 215 .br\r
 216 However the configfile will be read if \fBJunkbuster\fP notice a different\r
 217 modification time of this file and behaves so like start of \fBJunkbuster\fP \r
 218 in context of all the files.\r
 219  \r
 220 .SH NOTES\r
 221 This is a development version of \fBJunkbuster\fP. Not all features are  \r
 222 complete.\r
 223 \r
 224 .SH BUGS\r
 225 Yes. HTTP/1.1 support is only partially implemented. See the user-manual for \r
 226 how and where to report bugs.\r
 227 \r
 228 .SH SEE ALSO\r
 229 .br\r
 230 http://i.j.b/\r
 231 .br\r
 232 http://ijbswa.sourceforge.net/\r
 233 .br\r
 234 http://sourceforge.net/projects/ijbswa\r
 235 .br\r
 236 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
 237 .br\r
 238 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 239 .br\r
 240 http://privacy.net/analyze/\r
 241 .br\r
 242 http://www.squid-cache.org/\r
 243 .br\r
 244 http://linuxalpha.ch/packages/\r
 245 \r
 246 .SH DEVELOPMENT TEAM\r
 247 .br\r
 248  Stefan Waldherr \r
 249 .br\r
 250  Andreas Oesterhelt \r
 251 .br\r
 252  Jon Foster \r
 253 .br\r
 254  Markus Breitenbach\r
 255 .br\r
 256  Thomas Steudten\r
 257 .br\r
 258  David Schmidt\r
 259 .br\r
 260  Haroon Rafique\r
 261 .br\r
 262  Jorg Strohmayer\r
 263 .br\r
 264  Shamim Mohamed\r
 265 .br\r
 266  Sarantis Paskalis\r
 267 .br\r
 268  Gabriel L. Somlo\r
 269 .br\r
 270  John Venvertloh\r
 271 .br\r
 272  Hal Burgiss\r
 273 \r
 274 .SH COPYRIGHT AND LICENSE\r
 275 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 276 Corporation. \r
 277 .P\r
 278 This program is free software; you can redistribute it and/or modify\r
 279 it under the terms of the GNU General Public License as published by\r
 280 the Free Software Foundation; either version 2 of the License, or\r
 281 (at your option) any later version.\r
 282 .P\r
 283 This program is distributed in the hope that it will be useful,\r
 284 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 285 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 286 GNU General Public License for more details.\r
 287 .P\r
 288 You should have received a copy of the GNU General Public License\r
 289 along with this program; if not, write to the Free Software\r
 290 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 291 .P\r
 292 Internet Junkbuster\r
 293 Proxy\r
 294 is a\r
 295 trademark\" legal.html#marks\r
 296 of Junkbusters Corporation.\r