1 /*********************************************************************
3 * File : $Source: /cvsroot/ijbswa/current/README,v $
5 * Purpose : README file to give a short intro.
7 * Copyright : Written by and Copyright (C) 2001 the SourceForge
8 * IJBSWA team. http://ijbswa.sourceforge.net
10 * Based on the Internet Junkbuster originally written
11 * by and Copyright (C) 1997 Anonymous Coders and
12 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
32 *********************************************************************/
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.
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.
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. Several other developers are now contributing.
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,
64 For tarball, first unpack:
66 tar xzvf ijb-2.9.11-beta-src.tar.gz
69 autoheader [suggested for CVS source]
70 autoconf [suggested for CVS source]
71 ./configure (--help to see options)
72 gmake (the make from gnu)
74 make -n install (to see where all the files will go)
75 make install (to really install)
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.
82 Junkbuster is also available via anonymous CVS:
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
87 This will create a directory named 'current'. Then, 'cd current', and then
94 junkbuster [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
95 [--user USER] [config_file]
97 Or for RedHat: /etc/rc.d/init.d/junkbuster start
98 Or for SuSE: /etc/rc.d/junkbuster start
100 See the man page or user-manual for a brief explanation of each.
106 See: 'config', 'ijb.action', and 're_filterfile'. These are all well
107 commented. On Unix-like systems, these files are installed in /etc/junkbuster.
108 On Windows, then wherever the executable itself is installed. There are many
109 significant changes and advances since v2.0.x. The user-manual has a
110 run down of configuration options, and examples:
111 http://ijbswa.sourceforge.net/user-manual/.
113 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>,
114 or whatever you specify in the config file under 'listen-address'.
115 DEFAULT is localhost:8118.
117 The ijb.action file can be configured via the web interface accessed via
118 http://i.j.b/, as well other options.
124 There is a growing amount of documentation in the 'doc'
125 subdirectory, but it is not finished at this point. In particular, see
126 the user-manual there, and developers should look at
129 The best source of information on the current development version, may
130 still be either comments in the source code, or the included configuration
131 files, which are all well commented. These are 'config', 'ijb.action', and
132 're_filterfile' in the toplevel source directory.
134 Some legacy documentation may also be included only to give an idea of
135 what Junkbuster can do under doc/obsolete/*. Much has changed since
136 these docs were written, so beware.
138 Included documentation may vary according to platform and packager.
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
151 -------------------------------------------------------------------------
152 ijbswa-developers@lists.sourceforge.net
154 $Id: README,v 1.14 2002/03/05 01:18:45 hal9 Exp $