Installation » Upgrading

Upgrading your Etomite Install

NOTE:

Before performing any actions please check for and read any README file located in the root directory of the source files in the upgrade package. The instructions there may be newer than what is written here.

Upgrading from Etomite 0.6.1.4 to 1.0

All existing installations being upgraded which have a release number prior to Etomite Prelude v1.0 will require various database updates. Once you have successfully completed the configuration file modifications listed below it is mandatory that you run the script, v1_db_patches.php, before attempting to access your sites main page or entering your Etomite Manager. You can execute this script by clicking on the script name link in the installer upgrade area, upon successful completion, you can return to the main upgrade script - or you may opt to run the script independently. Attempting to run the script on a previously updated database will not result in any problems - you will simply receive messages stating an OK completion status for each item.
It is advisable that you use the new config file (as it includes some path issues on certain servers).

Upgrading from Etomite 0.6.1.x to 0.6.1.4

There are a few DB changes in this version. There is no need to manually make these changes, as there is a script to do it for you, included within the Upgrade page of the installer. Make sure you backup your existing files, just in case, before proceeding. You should also make sure that you have the database setttings located at the top of your manager/includes/config.inc.php file for future reference.

Next, over-write your manager folder and its subdirectories, as well as the index.php file located within the root of your etomite install, and the install folder.

Although you may be able to reuse your original config file it is recommended that you use the new version. To create a new config.inc.php file, edit the new manager/includes/config.inc.generic.php file by changing the database settings to match those in your original config.inc.php file and then save it as manager/includes/config.inc.php.

Looking carefully you will also notice that additonal code and documentation has been added to the config file which can be used to configure custom session handling. Do not attempt to enable custom session handling at this time. Only attempt these changes after you have successfully completed the standard upgrade. If you opt to retain your original config.inc.php file, simply copy the previously backed up file back to its original location.

Finally, login to your manager and refresh the site cache.

Performing the upgrade - Prior to 0.6.1.4

This is what you should do if you want to upgrade from Etomite 0.6 or any 0.6.1 beta release to Etomite 0.6.1.x Final (Prelude):

  1. Download Etomite 0.6.1.x Final and extract the files into a temporary directory. If you can, use the .tar.gz or the .bz2 archive, since some users have reported problems caused by archiver programs messing up the files in the .zip file.
  2. Make a full backup of your current Etomite install, just in case anything happens.
  3. Make a seperate backup of the files /manager/includes/config.inc.php
  4. Take your current Etomite site offline
  5. Upload the new index.php and the entire manager/ directory (including subdirectories of course).
  6. Copy /manager/includes/config.inc_generic.php to /manager/includes/config.inc.php and edit the file to include your own database settings ()frpm the previous file you've just saved) and save the file.
  7. Delete your sites assets/cache/etomiteCache.idx.php (etomiteCache.idx for those upgrading from Etomite 0.6 Heliades).
  8. Delete ALL assets/cache/docid_*.etoCache files.
  9. Upgrade your database as described below. (The site_content table has changed.) [this is only relevant if you are upgrading from 0.6.0 to 0.6.1.x]
  10. Log into the 0.6.1.x Etomite manager, check all your configuration settings and save.
  11. Clear the site's cache by clicking 'Clear site cache' in the manager's main menu
  12. Enter the configuration and change the site status back to 'Online'
  13. Log out and test your brand new site!

If it doesn't work, first check particularly that you've carried out steps 7,8 and 9 above!

Upgrading the Etomite database

There are two methods for modifying the site_content table - pick the one which suits your needs:

New Etomite resources

None of your existing Etomite resources (Chunks, Documents, Keywords, Snippets, Templates) will be replaced, nor will any new resources be added. All new resources, which are installed during a new installation, will be made available through Etomite.org as optional additions to your existing site(s).

Known issues

User login changes affect some Snippets

To quote Ralph:

Due to how Etomite is now handling sessions the front end parser doesn't share a sessions with the back end manager... Because of this you must explicitly login from the front end...

As a result, those snippets that integrate with the etomite manager accounts will appear not to work with etomite 0.6.1, because logins through the manager are no longer visible. This includes the etoGal, etoIMS, etoBlog, and Blogger snippets, and possibly others. If you are using these snippets, you will need to make provision for logging in from the main web site for people who previously logged in to the manager. This is best done by using the new authenticate_visitor snippet.

InnoDB database tables 

If you upgrade from etomite 0.6 to etomite 0.6.1, your database will continue to use InnoDB tables for the visitor logging. If you do not use, and do not intend to use, visitor logging this is not a problem, however the use of these tables is believed to have been responsible for problems experienced by a few etomite users. New installations use standard tables for all tables, including visitor logging. (InnoDB tables offer some advantages for complex applications (in particular transaction support) but are not fully integrated with MySQL 3 or 4, and so have disadvantages as well (in particular an inability to repair tables). The additional features are not used by etomite, so returning to the standard MyISAM tables is a sensible step.)

This is covered in the forum in this thread