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 (alpha) Date: 2001/12/01"\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 configuarion \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 that DO need 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 {+imageblock}\r
 145  .adforce.imgis.com\r
 146  .ad.preferences.com/image.*\r
 147  .ads.web.aol.com\r
 148  .ad-adex3.flycast.com\r
 149  .ad.doubleclick.net\r
 150  .ln.doubleclick.net\r
 151  .ad.de.doubleclick.net\r
 152  /.*/count\\.cgi\\?.*df=\r
 153  194.221.183.22[1-7]\r
 154  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
 155 \r
 156 # Block any URLs that match these patterns\r
 157 {+block}\r
 158  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
 159  /.*/(plain|live|rotate)[-_.]?ads?/\r
 160  /.*/(sponsor)s?[0-9]?/\r
 161  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
 162  /.*/adbanners/\r
 163  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
 164  /.*/banners?/\r
 165  /.*/popupads/\r
 166  /.*/advert[0-9]+\\.jpg\r
 167  /ad_images/\r
 168  /.*/ads/\r
 169  /images/.*/.*_anim\\.gif\r
 170  /rotations/ \r
 171  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
 172  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
 173  .images.nytimes.com\r
 174  .images.yahoo.com/adv/\r
 175  /.*cnnstore\\.gif\r
 176 \r
 177 .fi\r
 178 .sp\r
 179 .PP\r
 180 See the comments in the configuration files themselves, or the user-manual \r
 181 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
 182 options.\r
 183 \r
 184 .SH "FILES"\r
 185 \fI/usr/sbin/junkbuster\fP\r
 186 .br\r
 187 \fI/etc/junkbuster/config\fP\r
 188 .br\r
 189 \fI/etc/junkbuster/ijb.action\fP\r
 190 .br\r
 191 \fI/etc/junkbuster/re_filterfile\fP\r
 192 .br\r
 193 \fI/var/log/junkbuster/logfile\fP\r
 194 \r
 195 .P\r
 196 Various other files should be included, but may vary depending on platform \r
 197 and build configuration. More documentation should be included in the local\r
 198 documentation directory, though is not complete at this time.\r
 199 \r
 200 .SH NOTES\r
 201 This is a development version of \fBJunkbuster\fP. Not all features are  \r
 202 complete.\r
 203 \r
 204 .SH BUGS\r
 205 Yes. HTTP/1.1 support is only partially implemented. See the user-manual for \r
 206 how and where to report bugs.\r
 207 \r
 208 .SH SEE ALSO\r
 209 .br\r
 210 http://i.j.b/\r
 211 .br\r
 212 http://ijbswa.sourceforge.net/\r
 213 .br\r
 214 http://sourceforge.net/projects/ijbswa\r
 215 .br\r
 216 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
 217 .br\r
 218 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 219 .br\r
 220 http://privacy.net/analyze/\r
 221 .br\r
 222 http://www.squid-cache.org/\r
 223 \r
 224 .SH DEVELOPMENT TEAM\r
 225 .br\r
 226  Stefan Waldherr \r
 227 .br\r
 228  Andreas Oesterhelt \r
 229 .br\r
 230  Jon Foster \r
 231 .br\r
 232  Markus Breitenbach\r
 233 .br\r
 234  Thomas Steudten\r
 235 .br\r
 236  David Schmidt\r
 237 .br\r
 238  Haroon Rafique\r
 239 .br\r
 240  Jorg Strohmayer\r
 241 .br\r
 242  Shamim Mohamed\r
 243 .br\r
 244  Sarantis Paskalis\r
 245 .br\r
 246  Gabriel L. Somlo\r
 247 .br\r
 248  John Venvertloh\r
 249 .br\r
 250  Hal Burgiss\r
 251 \r
 252 .SH COPYRIGHT AND LICENSE\r
 253 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 254 Corporation. \r
 255 .P\r
 256 This program is free software; you can redistribute it and/or modify\r
 257 it under the terms of the GNU General Public License as published by\r
 258 the Free Software Foundation; either version 2 of the License, or\r
 259 (at your option) any later version.\r
 260 .P\r
 261 This program is distributed in the hope that it will be useful,\r
 262 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 263 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 264 GNU General Public License for more details.\r
 265 .P\r
 266 You should have received a copy of the GNU General Public License\r
 267 along with this program; if not, write to the Free Software\r
 268 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 269 .P\r
 270 Internet Junkbuster\r
 271 Proxy\r
 272 is a\r
 273 trademark\" legal.html#marks\r
 274 of Junkbusters Corporation.\r