junkbuster.1

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