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