Upgrading HiveMail
==================

This document will guide you through upgrading your copy of HiveMail. If
at any time you are stuck or feel like you need help, please do not
hesitate and contact us at support@hivemail.com. This is an offline
version of our upgrade guide at:
http://manual.hivemail.com/upgrade.html


TABLE OF CONTENTS:
------------------

  Chapter 1. Preparations and Uploading Files
  Chapter 2. Upgrading the Pipe Gateway
  Chapter 3. Upgrading the Database and Options
  Chapter 4. Upgrading the Templates


1. PREPARATIONS AND UPLOADING FILES
-----------------------------------

  After downloading the HiveMail zip archive from the Members Area, unpack
  the files in it to your computer, ensuring that you maintain the directory
  structure (a tool such as WinZIP will get the job done). You should now
  have two folders, email and upload, and two files, called INSTALL and
  UPGRADE.

  After unpacking the files, you need to upload them to your Web server. Log
  on to your site using your favorite FTP client, and browse to the folder
  at which HiveMail is installed. You need to upload all files from the local
  /upload folder to the remote folder, overwriting any files that are already
  in it (the files you are overwriting are from the previous release of
  HiveMail, and are outdated).


2. UPGRADING THE PIPE GATEWAY
-----------------------------

  Note: This step only needs to be taken if you are using the Pipe Gateway.
  More information regarding this subject can be found here:
  http://manual.hivemail.com/installation.html

  Besides updating the Web interface files, you also need to update the file
  called hivemail_process.php that fetches the messages from your server. The
  new version of this file is located in the /email folder you unpacked from
  the ZIP archive earlier. Again, connect to your Web site with your FTP
  client, find the location of the current file and overwrite it with the new
  version of it. After uploading the file, CHMOD it to 755 (in visual FTP
  clients this can usually be done by right-clicking on the file and choosing
  the appropriate option).


3. UPGRADING THE DATABASE AND OPTIONS
-------------------------------------

  Now that the files are on your Web server, you are ready to run the upgrade
  script. To do so, point your browser to the upgrade.php file under the
  /install folder - for example, if the program is installed at
  http://www.example.com/hivemail/, you should go to
  http://www.example.com/hivemail/install/upgrade.php. After each and every
  step you will see a link at the bottom of the page with an arrow, click it
  to proceed to the next step.

  In the welcome screen of the script you will be given a list of versions
  you can upgrade from - the version of HiveMail you are currently running.
  The script will display one option in bold, and that's the version you are
  running according to your database. After choosing the correct version, the
  script will create new tables in your database and change or remove current
  tables. Afterwards the script will populate the database with new records or
  add update current records (such as default options, user groups, etc).


4. UPGRADING THE TEMPLATES
--------------------------

  When you ran the upgrade script (in Chapter 3) all default templates in your
  system were overwritten by the new templates from the updated version.
  However, you have probably customized a number of templates, and those
  changed templates were not overwritten in the upgrade.

  To make sure your templates are all up to date, you need to compare your
  customized templates against the original. Visit the template editor in the
  admin control panel and find all templates you have customized that need to
  be upgraded.* Next to each template you will see a [compare to original]
  link, clicking it will bring up the template comparison screen where you can
  see, side by side, the custom and original template. Compare the two
  templates and make the necessary changes to the custom template (on the
  left). When you are done, click the Update Custom Template button to submit
  the changes.

  * You only need to update templates that were changed in the upgrade. The
  list of changed templates can be grabbed from the upgrade script or from the
  release announcement at the forums. Please note that if you upgrade, for
  example, from version 1.0 to 1.2, you need to update templates that were
  changed in the upgrade from 1.0 and in the upgrade from 1.1.