Installing Vlogin
=================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 3.4 version of the vlogin plugin.

  $ cd plugins
  $ tar -zxvf vlogin-3.4-1.2.7.tar.gz

2) This step is optional if Vlogin default behavior suits your
   needs.  However, since every system differs greatly, there 
   is a good chance that you will have to commence with this 
   step of creating your own set of configuration settings.

   Read the "Quick Start" section in the README file for more 
   help deciding which of the following steps you should 
   perform (you ONLY need to do ONE of these):

   A) Change into the vlogin/data directory, copy config.sample.php
      to config.php and edit config.php, making adjustments as 
      you deem necessary.  For more detailed explanations about 
      each of these parameters, consult the README file.

      $ cd vlogin/data
      $ cp config.sample.php config.php
      $ vi config.php

   B) Change into the vlogin/data directory, copy one of the 
      sample configuration files such as config.sample.typical.php
      to config.php and edit config.php, making adjustments as 
      you deem necessary.  For more detailed explanations about 
      each of these parameters, consult the README file.

      $ cd vlogin/data
      $ cp config.sample.typical.php config.php
      $ vi config.php

   C) Change into the vlogin/data directory, copy meta_config.sample.php
      to meta_config.php and edit meta_config.php, turning on the "meta
      configuration set" that suits your situation.  For more detailed 
      explanations about each of the available "meta configuration sets",
      consult the README file.

      $ cd vlogin/data
      $ cp meta_config.sample.php meta_config.php
      $ vi config.php

   D) Skip to step 3 if vlogin default behavior will work for you.
      For more information about Vlogin defaults, consult the "Quick
      Start" and "Configuration" sections in the README file.

3) Then go to your config directory and run conf.pl.  Choose
   option 8 and move the plugin from the "Available Plugins"
   category to the "Installed Plugins" category.  Save and exit.

  $ cd ../../../config/
  $ ./conf.pl


---------- optional ----------

If you need to change certain settings such as IMAP server, you
will need to download the Multilogin plugin and use the patch(*)
included with it to make one small modification of the SquirrelMail
code.  If you do so, you must also set $useSessionBased = 1 in 
vlogin's config.php file (mentioned above).  
* Note that as of SquirrelMail 1.5.2, no patch is needed; just 
  download Multilogin and no more.  Starting with SquirrelMail
  1.5.2, $useSessionBased with Multilogin is thus HIGHLY recommended.

Please note that this is only necessary for a subset of SquirrelMail
settings such as IMAP server, and many installations will not 
require this extra step.  However, the $useSessionBased functionality
will provide some performance increase and will ensure that you can
change most any SquirrelMail setting from within Vlogin.  If you 
can manage the extra requirements, this is highly recommended.

Also, when facing problems with Vlogin settings apparently "not 
sticking", this is the first thing you should do to try and fix
such problems.

Please read the instructions in the Multilogin INSTALL file for
how to make the change to the SquirrelMail source code (you can
safely ignore all other steps in that INSTALL file, except step
number 1).

---------- optional ----------



Upgrading Vlogin
================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 3.4 version of the vlogin plugin.

  $ cd plugins
  $ tar -zxvf vlogin-3.4-1.2.7.tar.gz


2) Change into the vlogin/data directory, check your config.php
   file against the new version, to see if there are any new 
   settings that you must add to your config.php file.

  $ cd vlogin/data
  $ diff -Nau config.php config.sample.php

   Or simply replace your config.php file with the provided sample
   and reconfigure the plugin from scratch (see step 2 under the
   installation procedure above).

