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