This is an old revision of the document!
Table of Contents
glFusion Upgrade Instructions
Before you begin the upgrade process, make a good backup of your source files and your database. The upgrade process is generally very safe, however, there is always the possibility that something could go wrong and part of any good upgrade plan is a good back out plan.
Generally, the upgrade process is nothing more than uploading the new release and running the Upgrade Wizard. Some new releases may require that you update a config file. These steps will be documented in much more detail below.
Major Releases may have changes or enhancements that alter some of the features you use, be sure to understand the impact of these changes prior to moving forward with the upgrade. See the What's New page for details.
If you have questions or run into problems, feel free to post your issue in the glFusion Support Forums and we'll do our best to get it answered as soon as possible.
To ensure a smooth upgrade process and to prevent any problems after the upgrade, you will need to validate the following items before you upload or begin the upgrade process.
- Determine the current version of your glFusion installation. You can find the current version of glFusion installed on your site by visiting the Command and Control screen. The glFusion version number is included in the title.
- Review the What's New page to understand if there are any major changes that might impact your site.
- If you are using a theme other than CMS, make sure your theme has been updated to support glFusion. There are several theme changes that must be made to custom themes to allow glFusion to work properly. Verify you have all the necessary template changes made by visiting the Template Changes page.
- If you have customized any of the theme templates, check the Template Changes for the current release to see if you need to make any updates to your customization's.
- Check any third party plugins to ensure they are compatible or if they will need to be updated.
- If you have made any changes to the glFusion core files or the theme files, ensure you save a copy of your modifications as they will be overwritten during the upgrade process.
Perform a Backup!
Take extreme care to back up any files from your current installation that have any custom code in them, especially lib-custom.php (where all custom code should reside). Be sure to back up any modified themes and images from your current installation.
Perform a full database backup and save the backup file offline.
Upload the new glFusion Release
glFusion provides 2 types of distribution files:
- Incremental Release Archive
The Incremental Release Archive must only be used when upgrading from the previous release to the current release. For example, if you are upgrading glFusion from v1.7.3 to v1.7.4, you can use the incremental release with contains only the files changed from the previous release.
If you are upgrading from glFusion v1.5.1 to v1.7.4 - you must use the FULL distribution archive.
If you are upgrading from glFusion v1.7.0 to v1.7.4 - you must use the FULL distribution archive.
- Full Release Archive
- The full release archive contains all glFusion files. You should use this when upgrading from an older release.
Overwriting Old Files with New Files
All the files in the distribution archive must be copied to your web server. For detailed instructions on how to upload the files, refer to the following sections from the installation guide:
It is important that you ensure you have successfully overwritten the old glFusion files with the new files from the glFusion distribution.
Running the Upgrade Wizard
Once you have all the new glFusion release files on your site, you will need to run the Upgrade Wizard. There is no need to disable anything or make any site configuration changes before running the Upgrade Wizard.
Select Upgrade an Existing glFusion Site as the installation option.
glFusion's update process should now make all the necessary changes to your database tables and upgrade all bundled plugins.
The Upgrade Wizard will perform the following steps:
- Display an information screen reminding you to follow all the instructions above!
- Perform an Environment Check
- Validates directory permissions - if any issues are identified - you must fix them before proceeding
- Validates PHP / MySQL environment
- Performs the upgrade - this will update the database tables as needed
- Obsolete File Removal Prompt - It is highly recommended that you let glFusion automatically remove old, obsolete files. A list of Obsolete Files is here
Post Upgrade Considerations
Check with your hosts's technical support if you need assistance in purging the hosting environment caches.
Removing Obsolete Files
Over time, glFusion may consolidate or remove files from the distribution. It is a best practice to remove these unused files. The glFusion Upgrade Wizard will automatically delete the files if you choose. If you would prefer to review the files that will be removed - a list of Obsolete Files is maintained here.
If you selected to skip the automatic removal of obsolete files, you can either remove them manually, or you can run the Upgrade Wizard again and select Delete Files when prompted to remove obsolete files. There is no harm in running the upgrade wizard multiple times.
Removing the Installation Files
It is important to either remove or rename the install/ directory on your site. Leaving the installation files in place is a security issue. Please select the Remove Install Files button to automatically remove all the Installation files. If you choose to not remove the installation files - please manually rename the admin/install/ directory to something that is not easily guessed.
Select the Remove Installation Files button to have glFusion automatically remove all the install files.