The standard way to upgrade kiwitrees to a new version is very simple. You should upgrade whenever a new version is made available. Even minor kiwitrees version updates usually contain a significant number of bug fixes as well as interface improvements and program enhancements. Registered users will be notified whenever an update is available.
- As a precaution, it is always a good idea to back up your kiwitrees database before proceeding with an upgrade. A useful tool to simplify this process is the kiwitrees module “Database backup“.
- Download the latest version of kiwitrees available from here.
- While you are in the middle of uploading the new files a visitor to your site would encounter a mixture of new and old files. This could cause unpredictable behaviour or errors. To prevent this put your site into “maintenance mode”. Go to Administration > Site administration > Site configuration, tick ‘yes’ by Site maintenance and save. While you continue with the next step, leave your browser open at that page.
- Unpack the ZIP file on your desktop computer, and upload all the files to your web server, overwriting the existing files.
- When everything has been copied (and do check this as some FTP software can miss a few files) go back to your open browser tab (from 3. above) and click on Dashboard > Home. This is an important step in most upgrades and should be done before you disable the site maintenance setting. Most upgrades will include automatically deleting old files, and some will need database changes. These are triggered by visiting the dashboard home page. This will generally take less than one second.
- Now you can check your site is still working correctly. Review the main pages and look for anything obviously wrong. Take special note of any changes or new additions described on this site and our newsletter/email and see if any of those need configuring.
- Once you are happy the upgrade is OK, return to Administration > Site administration > Site configuration, tick ‘no’ by Site maintenance and save. Your users can now access the site and enjoy the new features!
1 – Depending on the changes in the new files, your browser configuration and possibly other factors, it is always wise to clear both the kiwitrees cache and your browser cache immediately after the upgrade is completed. The kiwitrees cache can be cleared simply by going to Administration > Site administration > Clean up data directory and deleting the cache. For information about clearing your web browser cache see this FAQ.
2 – If you have missed one or more versions, you do NOT need to upgrade to each one in between. It is OK to upgrade directly from (say) ver 3.3.5 to ver 3.3.10. But do read all the intervening upgrade hints between you versions first, in case there are changes in the in-between versions that have imapcts on your or your system specifically.
NOTE for anyone using custom code (modules, themes, etc. not supplied in the kiwitrees download package). It is very likely your custom code will not work when you upgrade kiwitrees. Therefore you should disable all custom code before you apply the upgrade. Disable custom modules, switch over to a standard theme, and remove any code “hacks”. Once the upgrade is complete and you are satisfied your site is fully operational contact the source of those modules or themes for a new version.
NOTE for Macintosh users. Step 4 assumes you are using a copy tool that merges directories rather than replaces them. (Merge is standard behaviour on Windows and Linux.) If you use the Macintosh Finder or another similar tool to perform step 3, it will can replace your configuration, media and other directories with the empty/default ones from the installation. This would be very bad (but you did take a backup in step 1, didn’t you!). Further details and recommendations for suitable tools can be found by searching google.com