Installing The Yubikey Plugin
=============================

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

  $ cd plugins
  $ tar -zxvf yubikey-1.0-1.4.0.tar.gz

2) 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,
      change into the yubikey directory and copy the example
      configuration file to config.php and edit config.php, making
      adjustments as you deem necessary.

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

   B) To store the configuration file in the main SquirrelMail
      config directory, change into the yubikey directory
      and copy the example configuration file to
      ../../config/config_yubikey.php and edit
      ../../config/config_yubikey.php, making adjustments
      as you deem necessary.

     ----- optional -----
     $ cd yubikey
     $ cp config_example_sql.php ../../config/config_yubikey.php
     $ vi ../../config/config_yubikey.php
     ----- optional -----

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

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



Upgrading The Yubikey Plugin
============================

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

  $ cd plugins
  $ tar -zxvf yubikey-1.0-1.4.0.tar.gz

2) Change into the yubikey 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_yubikey.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).

