Muffin 0.4 README
Copyright (C) 1996-97 Mark Boyns <boyns@sdsu.edu>

Muffin - Filter the Web

Muffin is filtering proxy server for the World-Wide Web.  Anything
sent between the web browser and server can be filtered.  This
includes HTTP headers and content types such as text/html and
image/gif.  Filters are add-on modules loaded at runtime.  Several
example filters are included, but users are encouraged to write their
own using the provided ReplyFilter, RequestFilter, and ContentFilter
API.

Filters:

AnimationKiller - Kill GIF89a animations by either limiting the number
                  of loops or turning them into broken images.

CookieMonster - Remove HTTP Cookie headers `Cookie' and `Set-Cookie'.

Logger - Keep a log of accessed URLs.

Referer - Change the HTTP referer header to any URL or choose from a list.

SecretAgent - Change the HTTP User-Agent header to any web browser or
              choose from a list.

SecretServer - Change the HTTP Server header.

Snoop - View all HTTP headers.

Stats - Maintain various stats about your HTTP session. Useful to
        calculate the exact site of a web page.

Availability:

Muffin is free software distributed with the GNU General Public
License. Please see www.fsf.org if you don't understand what this
means.  The main distribution site is http://muffin.doit.org/.

Requirements:

This version requires the Java Developers Kit version 1.1.
Tested kits:

    * Solaris 2.5 - JDK 1.1.2 and JDK 1.1.3

    * Debian GNU/Linux 1.3 - JDK 1.1.1

    * Windows 95 - JDK 1.1.3

Any JDK version less than 1.1 will *not* work.
Obtain the JDK from the following sites:

    * Solaris 2.5, Windows NT, Windows 95 - http://www.javasoft.com/

    * Linux - http://www.blackdown.org/java-linux.html

Starting Muffin:

Unix:

$ cd muffin-0.4
$ java muffin.Main

Windows:

c:\> cd \muffin-0.4
c:\muffin-0.4> \jdk1.1.3\bin\java muffin.Main

Alternatively the java CLASSPATH can be set to include the directory
where Muffin is installed.

Web browsers need to be configured to use Muffin as a proxy server.
By default, Muffin listens on port 51966 and will only allow
connections from the host it was started on.  Changed Muffin and
filter options can be saved to be used in future sessions.

One important command line option is -nw which allows Muffin to run
without a window system.  Example: java muffin.Main -nw
See `java muffin.Main -help' for option information.


See the COPYING file for license information.
See the INSTALL file for compilation and installation instructions.
See the NEWS file for a list of user-visible changes.
See the TODO file to find out what may be fixed/changed/implemented.
See the BUGS file for a list of known problems.

Send suggestions and bug reports to Mark Boyns <boyns@sdsu.edu>.
