Installing The One-Time Password Plugin
=======================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the One-Time
   Password plugin.

  $ cd plugins
  $ tar -zxvf otp-1.0-1.4.18.tar.gz

2) Read the security section in the README file and decide
   how you will make your cryptographic settings.  Hopefully
   you'll be using the apache.conf file.  Copy it from
   apache.conf_example, edit it and customize the settings
   therein, then move it to your web server configuration
   directory and make it readable ONLY to the root user
   (you'll need to do this as root yourself).

  $ cd otp
  $ cp apache.conf_example apache.conf
  $ vi apache.conf
  $ mv apache.conf /etc/httpd/conf.d/one_time_password.conf
  $ su
  # chown 0:0 /etc/httpd/conf.d/one_time_password.conf
  # chmod 600 /etc/httpd/conf.d/one_time_password.conf

   You can also make apache "Include" this file located elsewhere,
   such as when working with Apache 1.3 by following the instructions
   in apache.conf_example to build the correct Include directive
   to put in /etc/httpd/conf/httpd.conf, but you should still make
   sure that the file is owned and permissioned as shown above!

   If you have decided to use the PHP-based cryptographic
   settings (shame on you!), you can do that in the next step.

3) Decide if you want to store the plugin configuration file in
   the plugin directory or in the main SquirrelMail config directory.

   A) To store the configuration file in the plugin directory,
      copy config_example.php to config.php and edit config.php,
      making adjustments as you deem necessary.

     ----- optional -----
     $ cp config_example.php config.php
     $ vi config.php
     ----- optional -----

   B) To store the configuration file in the main SquirrelMail
      config directory, copy config_example.php to
      ../../config/config_otp.php and edit
      ../../config/config_otp.php, making adjustments as you deem
      necessary.

     ----- optional -----
     $ cp config_example.php ../../config/config_otp.php
     $ vi ../../config/config_otp.php
     ----- optional -----

4) 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

5) Also please verify that you have the "Compatibility" plugin
   installed (but not necessarily activated).

6) Translations are not included in this package.  To get a
   translation, download the language pack needed from:

      http://www.squirrelmail.org/download.php



Upgrading One-Time Password
===========================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the One-Time
   Password plugin.

  $ cd plugins
  $ tar -zxvf otp-1.0-1.4.18.tar.gz

2) Change into the otp directory and 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.

  $ diff -u config.php config_example.php

   If you store your configuration file in the main SquirrelMail
   config directory, adjust this command as follows:

  $ diff -u ../../config/config_otp.php config_example.php

   Or simply replace your configuration file with the provided
   example and reconfigure the plugin from scratch (see step three
   under the installation procedure above).

