_        _  ______  ___________  _______
 \      /  /      \ \    |    / /      /
  \    /  /        \ \   |   / /______/
   \  /  /----------\ \     / /          (VAMP)
   _\/_  \          / /     \ \          2.0 (or any version >= 1.9)


This document describes how to install the VAMP webmail system. If you have
not done so already, please read the INTRO document for an explanation of 
what VAMP can do for you or your company. Please note that this document
assumes you are running Apache as your HTTP daemon, and you have installed
the Apache PHP3 module (with SQL support). If you don't: GOOD LUCK!


1) REQUIREMENTS:
VAMP requires, as stated before, Apache with PHP3 and PHP3 SQL support (for
now, only MySQL and PostgreSQL are supported by VAMP!!). If your system
has no support for any of these options, you're on your own! Also, VAMP
will send E-Mail through an SMTP-server. Make sure you got one running, or
at least make sure you got access to some foreign SMTP server. And ofcourse
a POP3 server (that's right: IMAP's no longer supported). Virtual Domains
and virtual users no longer require a "crypt" functions. Passwords are
hashed using MD5.

VAMP was developed and tested on a machine with the following specs:
 - OS: Linux (SuSE 6.4 distribution)
 - HTTPD: Apache 1.3.12 with PHP3 and PHP3-MySQL/PostgreSQL support (out
   of the SuSE box)
 - Tested browsers: Netscape 4.7 (but any browser, including Lynx should
   work)
 - SMTP daemon: Sendmail 8.9.3
 - POP3 server: qpopper
 - SQL Database: MySQL and PostgreSQL (both out of the SuSE-box).

VAMP is also being tested on a FreeBSD 4.0 machine of which I don't have specs
right now...

 - Special Apache parameters:
  - .html files are PHP3 parsed too ("AddType application/x-httpd-php3 .html"
    in httpd.conf, "AddHandler server-parsed .html" removed). If this is not
    an option, please rename all .html files in the WWW (NOT THE "inc")
    directory of the VAMP distribution to ".phtml" or ".php3".
  - A VirtualHost that points to the VAMP distribution's WWW directory (this
    should really be done for security matters!).
  - A VirtualHost that points to the VAMP distribution's setup directory. This
    is required only if you want to use the VAMP Setup and Administration
    tool, which I recommend. I won't tell you how the SQL tables are
    formatted, though you can easily find out by reading
    the "setup/setupbase-2.php3" file.

 - Special PHP3 parameters:
  - MAKE SURE MAGICQUOTES ON GET/POST IS OFF!!! ("magic_quotes_gpc = off" in
    your php3.ini file).

2) SETTING UP VAMP:
In this section I'll tell you how to set up VAMP. It requires a (BA)SH shell
environment and a web-browser (like Netscape or Lynx).

2.1) SETTING UP VAMP:
The following steps should be run as "root" or "administrator":
Create a VirtualHost in your Apache config that points to the WWW subdirectory
of the directory that you extracted VAMP to. Also, create a VirtualHost
that points to the "setup" subdirectory. Next, find out what user and
group Apache runs as (the "User" and "Group" statements in the Apache config).
Now go to the VAMP "root" or "top-level" directory and run the fixowns.sh
script located in this directory with as first parameter the username and as
second parameter the groupname Apache runs as:

sh ./fixowns.sh wwwrun nogroup

(assuming Apache runs as user "wwwrun" of group "nogroup"). Now all the owners,
groups and permissions of all files in the VAMP distribution are best
configured (I think/hope). Btw. run this as user root.

Now, edit the "inc/vampconfig.inc" file. Make sure you select either MySQL
or PostgreSQL bindings in the sqlBindings() function (by changing the
return value to any of the bindings files in the "bindings" subdirectory).
Also, make sure sqlDatabase() returns what you'd like to see as your VAMP
database. WARNING: THIS DATABASE WILL BE DROPPED (ANNIHILATED) WHEN YOU
CONTINUE THE VAMP SETUP.

2.2) VAMP DATABASE CREATION:
Point your web-browser at the VirtualHost you selected for the "setup"
directory. You should then enter the SQL superuser username and password.
Then make sure you selected "Create/clear the VAMP database and tables",
finally click the "Make it so"-button, and answer "Yes" to the warning.
The VAMP Database and tables should now have been created.

2.3) SERVER WIDE CONFIGURATION:
Next, assuming this is your first try with VAMP, and you don't want to
import the old VAMP-1.9.8 configuration (in which case you should read
the UPGRADE-1.9.8-1.9.9 file, and not this one), select the "Configure
VAMP common options" from the dropdown box. Click "Make it so" once
again.
You are presented with a list of options which are shared by all the
users. The first "SMTP server to use" should contain an IP address, or
a hostname of the SMTP server to use. "The port of the SMTP host to connect
to" should probably be 25 (this is the default SMTP port). The POP3 password
is a password that is the key to ALL the Virtual Domains POP3 boxes.

2.4) USERBASE SET UP:
From the main Setup menu, select "Edit / Maintain the VAMP userbase" and
click the "Make it so" button. You will find yourself in another menu.
From the dropdown box, you can select the various things you can do in
this menu. Here's a list of options that can be found through-out the
subpages of this menu:
 "Username" : The username to be used to log in to VAMP (not necesseraly the
              same as the POP3 username).
 "Virtual Domain name" : The part after the "@" shared by all virtual users
              of that Virtual Domain. So if all users would be like
              something@thegraveyard.org, thegraveyard.org would be the
              virtual domain name.
 "POP3 Server" : The server that contains the POP3 box for this user (it's
              formatted like this: <host>[:<port>], eg: localhost:110, or
              mail.dds.nl:110. (if you don't add the port, default POP3
              port 110 will be used).
 "Local domain" : Not a very important option. It contains the default
              domain a POP3 user belongs to. If your email address is
              "someon@thegraveyard.org", then "thegraveyard.org" would be the
              local domain.
 "POP3 username" : This is the actual username that is used to log in to the
              POP3 server. If you leave this empty, it will default to the
              username or "Virtual Domain"-name.
 "Virtual Domain" : The Virtual Domain this Virtual User belongs to. After
              adding a virtual user, the Virtual Username part will not
              exist anylonger. It will only exist as username@domain in
              the databases, so you can create both "undead@thegraveyard.org"
              AND "undead@somewhere.else.net".
 "Password" : The password to use for the Virtual User.

Well, I guess that's it... Not too hard, you have to agree...

3) THAT'S ALL FOLKS
Remember, this is probably still a beta version. It could contain some serious
bugs, errors or security flaws... Take care and use wisely...

You can contact me through email for questions etc. : undead@thegraveyard.org
My homepage:                                   http://undead.thegraveyard.org
VAMP homepage:                     http://undead.thegraveyard.org/?topic=vamp


Byebye!
