README

   1 /*********************************************************************\r
   2  *\r
   3  * File        :  $Source: /cvsroot/ijbswa/current/README,v $\r
   4  *\r
   5  * Purpose     :  README file to give a short intro.\r
   6  *\r
   7  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge\r
   8  *                IJBSWA team.  http://ijbswa.sourceforge.net\r
   9  *\r
  10  *                Based on the Internet Junkbuster originally written\r
  11  *                by and Copyright (C) 1997 Anonymous Coders and \r
  12  *                Junkbusters Corporation.  http://www.junkbusters.com\r
  13  *\r
  14  *                This program is free software; you can redistribute it \r
  15  *                and/or modify it under the terms of the GNU General\r
  16  *                Public License as published by the Free Software\r
  17  *                Foundation; either version 2 of the License, or (at\r
  18  *                your option) any later version.\r
  19  *\r
  20  *                This program is distributed in the hope that it will\r
  21  *                be useful, but WITHOUT ANY WARRANTY; without even the\r
  22  *                implied warranty of MERCHANTABILITY or FITNESS FOR A\r
  23  *                PARTICULAR PURPOSE.  See the GNU General Public\r
  24  *                License for more details.\r
  25  *\r
  26  *                The GNU General Public License should be included with\r
  27  *                this file.  If not, you can view it at\r
  28  *                http://www.gnu.org/copyleft/gpl.html\r
  29  *                or write to the Free Software Foundation, Inc., 59\r
  30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
  31  *\r
  32  *********************************************************************/\r
  33 \r
  34 This README is included with the development version of Junkbuster,\r
  35 which will eventually become Junkbuster v3.0. See\r
  36 http://ijbswa.sourceforge.net.\r
  37 \r
  38 Internet Junkbuster is a web proxy with advanced filtering\r
  39 capabilities for protecting privacy, filtering web page content,\r
  40 managing cookies, controlling access, and removing ads, banners,\r
  41 pop-ups and other obnoxious Internet Junk. Junkbuster has a very\r
  42 flexible configuration and can be customized to suit individual needs\r
  43 and tastes. Internet Junkbuster has application for both stand-alone\r
  44 systems and multi-user networks.\r
  45 \r
  46 JunkBuster was originally written by JunkBusters Corporation, and was\r
  47 released as free open-source software under the GNU GPL. Stefan\r
  48 Waldherr made many improvements, and started the SourceForge project\r
  49 to continue development.\r
  50 \r
  51  INSTALL\r
  52 --------\r
  53 \r
  54 For tarball, first unpack:\r
  55 \r
  56  tar xzvf ijb_source_* [.tgz or .tar.gz]\r
  57  cd ijb_source_2.9.9_alpha\r
  58 \r
  59  autoheader   [suggested for CVS source]\r
  60  autoconf     [suggested for CVS source]\r
  61  ./configure    (--help to see options)\r
  62  gmake          (the make from gnu) \r
  63  su \r
  64  make -n install        (to see where all the files will go)\r
  65  make install           (to really install)\r
  66 \r
  67 Redhat and SuSE src and binary RPMs can be built with 'make\r
  68 redhat-dist' or 'make suse-dist' (run ./configure first). BSD\r
  69 will (probably?) require gmake (from http://gnu.org). See the \r
  70 user-manual for OS/2 build instructions.\r
  71 \r
  72 Junkbuster is also available via anonymous CVS:\r
  73 \r
  74  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login\r
  75  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current\r
  76 \r
  77 This will create a directory named 'current'. Then, 'cd current', and then\r
  78 build as above.\r
  79 \r
  80 \r
  81  RUN\r
  82 ----\r
  83 \r
  84  junkbuster /etc/junkbuster/config \r
  85 \r
  86 Or for RedHat: /etc/rc.d/init.d/junkbuster start\r
  87 Or for SuSE:   /etc/rc.d/junkbuster start\r
  88 \r
  89 The only command line option supported is the location of the \r
  90 main configuration file. If none is specified, Junkbuster will \r
  91 look for a file named 'config' for unix, junkbstr.txt for win\r
  92 in the current directory.\r
  93 \r
  94 \r
  95  CONFIGURATION\r
  96 --------------\r
  97 \r
  98 See: 'config', 'actionsfile', and 're_filterfile'. These are all well\r
  99 commented. On Unix-like systems, these files are installed in /etc/junkbuster.\r
 100 On Windows, then wherever the executable itself is installed. There are many\r
 101 significant changes and advances since v2.0.x. The user-manual has a \r
 102 run down of configuration options, and examples: \r
 103 http://ijbswa.sourceforge.net/user-manual/.\r
 104 \r
 105 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>,\r
 106 or whatever you specify in the config file under 'listen-address'.\r
 107 DEFAULT is localhost:8000.\r
 108 \r
 109 \r
 110  DOCUMENTATION\r
 111 --------------\r
 112 \r
 113 The best source of information on the current development version, is\r
 114 either comments in the source code, or the included configuration\r
 115 files, which are all well commented. These are 'config',\r
 116 'actionsfile', and 're_filterfile' in the toplevel source directory.\r
 117 \r
 118 There is a growing amount of new documentation in the 'doc'\r
 119 subdirectory, but it is sparse at this point. In particular, see \r
 120 the user-manual there, which is 'nearly there'.\r
 121 \r
 122 Some legacy documentation is also included only to give an idea of\r
 123 what Junkbuster can do under doc/obsolete/*. Much has changed since\r
 124 these docs were written, so beware.\r
 125 \r
 126 \r
 127  BUGS\r
 128 -----\r
 129 \r
 130 Use the form at\r
 131 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r
 132 report bugs. Please read the exising bug reports before submitting\r
 133 anything new.\r
 134 \r
 135 -------------------------------------------------------------------------\r
 136 ijbswa-developers@lists.sourceforge.net\r
 137 \r
 138 $Id: README,v 1.7 2001/10/26 18:36:52 swa Exp $\r