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