README

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