REQUIREMENTS
-------------
Vadmin plugin 1.9.0 and above requires the following things:
    * PHP-4.1 or above (http://www.php.net/) compiled with the 
      following features:
        + dba (--enable-dba)
        + gdbm (--with-gdbm)
    * Squirrelmail 1.4.x series
    * Qmail-Autoresponder with a vmailmgr-enabling patch.
        + http://www.untroubled.org/qmail-autoresponder/
        + http://www.mricon.com/SM/qmail-autoresponder-0.96.1-vmailmgr.patch
        + http://www.mricon.com/SM/qmail-autoresponder.vdeliver-postdeliver
    
[OPTIONALLY]
    * libmcrypt support for strong cryptography.
    

INSTALLATION
------------
Untar in your squirrelmail plugins directory and move to "vadmin" from 
"vadmin-x.x.x". Change into that directory.

conf/
    First order of business is setting up your config files. They are
    located in the conf/ directory and are two: vadmin.conf and 
    apache.conf. 
    
    vadmin.conf
        This is the heart of your configuration. Peruse the comments inside
        the config file itself and set your paths and other things
        appropriately.
    
    apache.conf
        Edit apache.conf and change two things -- the path to your
        squirrelmail directory if it's not /usr/share/squirrelmail (in which
        case some people at FHS might want to have a word or two with you), 
        and change "LLAMA" to some unique string. This is the encryption
        hash that will be used to encrypt your vadmin data, including
        domain passwords. Make it something good. If you don't change it
        from "LLAMA," you will suffer the consequences when someone logs in
        and runs porn warez from your server.

        Once you have edited the file, you have two options. If you have
        /etc/httpd/conf.d directory (which is true for at least Red Hat
        Linux 8 and above), then just move that file into that dir. I.e.:
        mv apache.conf /etc/httpd/conf.d/vadmin-apache.conf. 
    
        If you don't have /etc/httpd/conf.d directory, then move the file
        into /etc/httpd/conf and add the following line into your global
        apache.conf:
        Include vadmin-apache.conf

        !!!IMPORTANT!!!
        Wherever you have moved the file, run the following commands on it:
        chown root:root vadmin-apache.conf
        chmod 0600 vadmin-apache.conf

        (for an in-depth explanation see "SECURITY" in this directory).

    [OPTIONALLY]
    It is a good idea to move the conf directory into /etc/vadmin. 
    This makes things like backups much cleaner and is FHS compliant. If
    you decide to do this, here are your steps (performed while in the
    vadmin plugin directory):
    * mv conf /etc/vadmin
    * perl -pi.bak -e \
        "s|config_file\s*=.*?;|config_file='/etc/vadmin/vadmin.conf';|g" *.php

    (or manually edit setup.php, vadmin_fetch_pic.php, and vadmin_main.php
    and set the $config_file variable to point to '/etc/vadmin/vadmin.conf'
    if perl-foo above makes you uneasy).


/var/lib/vadmin
    Now you have to set up /var/lib/vadmin (or some other place, if you have
    set a different path in [storage]->dir. Just run the following commands:
    * mkdir -p /var/lib/vadmin
    * chown -R apache:apache /var/lib/vadmin
    * chmod 0700 /var/lib/vadmin

    The second command may be different for you if your apache runs as
    user other than user "apache". On some platforms it's "nobody:nogroup"
    or "httpd:httpd". Check your apache config if in doubt.

modules/
    If you move them somewhere, make sure you reflect upon that in
    vadmin.conf. A good place is /usr/share/vadmin/modules. This puts them
    out of the web root.

includes/
    Similarly as with modules/, they would live well in 
    /usr/share/vadmin/includes (mind vadmin.conf).

locale/
    If you have some translations lined up, put this in
    /usr/share/vadmin/locale and set up vadmin.conf accordinly.


Enable the plugin in squirrelmail.
----------------------------------
This can be achieved by running conf.pl that ships with squirrelmail.

...

After all of the above restart your apache server and head over to README.

If stuff doesn't work, please see README and then send your support request
to squirrelmail-plugins@lists.sf.net with [Vadmin] in the subject.
