$Id: README,v 1.10 2004-09-12 12:19:15 tellini Exp $
----------------------------------------------------------------------------


           P R O M E T E O
                                         bringing fire to your LAN


----------------------------------------------------------------------------
About
----------------------------------------------------------------------------

prometeo (Italian spelling for Prometheus) is a modular proxy, developed
for his thesis in Computer Science by Simone Tellini,
<[email protected]>

It comes with the following modules:

 - an HTTP caching proxy
 - a FTP proxy with TLS support
 - a simple TCP tunnel
 - an SSL tunnel
 - a POP3 proxy with Spam Assassin support
 - etc...


----------------------------------------------------------------------------
Supporting the author
----------------------------------------------------------------------------

If you like prometeo and wish to show your support, you can order me
something off my Amazon wish-list, located at:

http://www.amazon.co.uk/exec/obidos/registry/1K4OWZ581SIRE/ref%3Dwl%5Fs%5F3/026-2575462-0900418



----------------------------------------------------------------------------
Requirements
----------------------------------------------------------------------------

Compulsory:

- a working C++ compiler
- autoconf 2.52+
- expat
- sablotron
- PAM or BSD Auth

Optional:

- zlib (for gzip/deflate support in mod_http)
- OpenSSL (for mod_ssl, TLS support in mod_ftp)



----------------------------------------------------------------------------
Installation
----------------------------------------------------------------------------

It follows the standard GNU guidelines, so read the INSTALL file for the
generic install instructions. Some configure options which you may want
to check out are:

 --enable-ipv6    to enable IPv6 support, if available (on Linux: make
                  sure to have the IPv6 module compiled in the kernel, or
				  insmod it)

 --with-openssl   to activate the SSL/TLS support for all the modules 
                  which need it

After you've compiled and installed prometeo, rename prometeo.xml.sample
to prometeo.xml (in <prefix>/etc) and invoke prometeo.

Except on BSD systems, you should also copy the file pam/prometeo to your
system's pam directory (on Mandrake it's /etc/pam.d) and edit it if you
like.

Now you can point your web browser to http://localhost:8081 to access 
the configuration panel, using root's credentials, or the ones of the
user who started prometeo, or another user if defined in the ACL section
of the configuration file (see comments in it).

Have fun. :)


Some notes
----------

I've had a small problem when trying to compile prometeo on OpenBSD 3.2: the
configure script gave an error when trying to run configure in libltdl. This
might be due to the fact that I had to set the LDFLAGS and CPPFLAGS env vars
in order to have some includes and libraries found (namely, expat in
/usr/local/lib and /usr/local/include, which were not part of the standard
include path): configure put LDFLAGS=... and CPPFLAGS=... in the command
line of the second configure, making it fail. If that happens to you too,
just 'cd libltdl' and invoke configure without those parameters, but
preserving the other ones, as reported in the error message.