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
  52  IMPORTANT CHANGE
  53 -----------------
  54
  55 IMPORTANT! READ! Configuration Change as of 03/04/02: The default
  56 listening port is now 8118 due to conflicts with port 8000 assignment.
  57 You will need to change your browser if upgrading!!! And maybe firewall,
  58 etc.
  59
  60
  61  INSTALL
  62 --------
  63
  64 For tarball, first unpack:
  65
  66  tar xzvf ijb-2.9.11-beta-src.tar.gz
  67  cd ijb-2.9.11-beta
  68
  69  autoheader   [suggested for CVS source]
  70  autoconf     [suggested for CVS source]
  71  ./configure    (--help to see options)
  72  gmake          (the make from gnu)
  73  su
  74  make -n install        (to see where all the files will go)
  75  make install           (to really install)
  76
  77 Redhat and SuSE src and binary RPMs can be built with 'make
  78 redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked
  79 sources. BSD will (probably?) require gmake (from http://gnu.org). See the
  80 user-manual for OS/2 build instructions.
  81
  82 Junkbuster is also available via anonymous CVS:
  83
  84  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  85  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
  86
  87 This will create a directory named 'current'. Then, 'cd current', and then
  88 build as above.
  89
  90
  91  RUN
  92 ----
  93
  94  junkbuster /etc/junkbuster/config
  95
  96 Or for RedHat: /etc/rc.d/init.d/junkbuster start
  97 Or for SuSE:   /etc/rc.d/junkbuster start
  98
  99 The only command line option supported is the location of the
 100 main configuration file. If none is specified, Junkbuster will
 101 look for a file named 'config' for unix, config.txt for Win32
 102 in the current directory.
 103
 104
 105  CONFIGURATION
 106 --------------
 107
 108 See: 'config', 'ijb.action', and 're_filterfile'. These are all well
 109 commented. On Unix-like systems, these files are installed in /etc/junkbuster.
 110 On Windows, then wherever the executable itself is installed. There are many
 111 significant changes and advances since v2.0.x. The user-manual has a
 112 run down of configuration options, and examples:
 113 http://ijbswa.sourceforge.net/user-manual/.
 114
 115 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>,
 116 or whatever you specify in the config file under 'listen-address'.
 117 DEFAULT is localhost:8118.
 118
 119 The ijb.action file can be configured via the web interface accessed via
 120 http://i.j.b/, as well other options.
 121
 122
 123  DOCUMENTATION
 124 --------------
 125
 126 There is a growing amount of documentation in the 'doc'
 127 subdirectory, but it is not finished at this point. In particular, see
 128 the user-manual there, and developers should look at
 129 developer-manual.
 130
 131 The best source of information on the current development version, may
 132 still be either comments in the source code, or the included configuration
 133 files, which are all well commented. These are 'config', 'ijb.action', and
 134 're_filterfile' in the toplevel source directory.
 135
 136 Some legacy documentation is also included only to give an idea of
 137 what Junkbuster can do under doc/obsolete/*. Much has changed since
 138 these docs were written, so beware.
 139
 140
 141  BUGS
 142 -----
 143
 144 Use the form at
 145 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to
 146 report bugs. Please read the exising bug reports before submitting
 147 anything new. We ask that these not be reported on the mailing lists,
 148 since this is harder to track, and to make sure all reports are
 149 addressed.
 150
 151 -------------------------------------------------------------------------
 152 ijbswa-developers@lists.sourceforge.net
 153
 154 $Id: README,v 1.13 2002/03/04 19:32:07 oes Exp $