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