Difference between revisions of "How to upgrade JReviews"

From JReviews Documentation
Jump to: navigation, search
Line 29: Line 29:
 
# Clear the browser cache! Otherwise you may end up with non-working links.
 
# Clear the browser cache! Otherwise you may end up with non-working links.
  
== Upgrading to JReviews 2.4 from earlier versions ==
+
== Upgrading to JReviews 2.7 from earlier versions ==
  
Since  this is a major version upgrade it won't be possible to upgrade remotely from earlier JReviews versions. Once you install JReviews 2.4  you'll be able to continue using the remote updater.
+
Read [[Upgrading to JReviews 2.7]]
 
+
# Create a development site first to test the upgrade. You can use website cloning tools like [https://www.akeebabackup.com/ Akeeba Backup] for this purpose.
+
# Uninstall GeoMaps and PaidListings add-ons via '''Install & Update''' page in JReviews administration..
+
# Remove any overrides. You can do this quickly by renaming the whole 'jreviews_overrides' folder to something else. Never rename this folder back to 'jreviews_overrides' because you will break JReviews. You can’t use any old JReviews 2.2 or JReviews 2.3 files with the new JReviews 2.4 version.
+
# Uninstall the S2Framework and JReviews components. Uninstalling JReviews modules and plugins is not necessary as these will be automatically upgraded when you re-install JReviews. Also uninstalling modules will result in the lose of all your existing menu associations which is something you want to avoid.
+
# Download the package from the client area, your upgrades need to be valid or you need to order a new upgrades package.
+
# Install the new S2Framework and JReviews and CLEAR the browser cache.
+
# If you have a GeoMaps, PaidListings or WidgetFactory license, install them from the remote installer in JReviews and CLEAR the browser cache.
+
# Go to the JReviews remote installer and install the '''Image Migrator add-on''' and then follow the instructions. You need to setup the storage settings for photos in JReviews Media Settings before you run the migrator.
+
 
+
== Upgrading to JReviews 2.5 from earlier versions ==
+
 
+
Follow the same steps outlined in the "Upgrading to JReviews 2.4 from earlier versions" section above. If you are upgrading from JReviews 2.4 then you can skip the image migration step.
+
 
+
* Check your click2search URLs. If you are using a format for the click2search URL in your field settings other than the default, it is possible that they no longer work in JReviews 2.5. The new format begins with "tag/fieldname/..." instead of "index.php?option=com_jreviews&url=tag/fieldname/...". Make sure you modify the format to allow your URLs to continue working. This is just a change in settings. The actual links on the site will not change once the setting is fixed.
+
 
+
== Upgrading to JReviews 2.6 from earlier versions ==
+
 
+
Read [[Upgrading to JReviews 2.6]]
+
  
 
== Troubleshooting a broken upgrade ==
 
== Troubleshooting a broken upgrade ==

Revision as of 21:00, 15 July 2016

What happens to my existing listings, reviews and customizations when I upgrade

Upgrading JReviews does not remove your configuration settings, or any of your existing data such as listings and reviews. These are stored in the database and the upgrades affect mostly the file system. If an upgrade requires database changes, then this is automatically taken care of by JReviews. If you've made any theme or code changes, you should make a backup of your modified files before proceeding with the upgrade.

Remote Upgrade

You can do a one-click remote upgrade by using the Install & Update menu in the JReviews administration under the Maintenance header on the left column. Always upgrade the s2framework first and JReviews second.

Remember to backup any files you've customized because they will be replaced during the upgrade. You can use the JReviews Code Overrides to move the files outside the core folders to prevent them from being overwritten.

We recommend that you use a development server to test the upgrade first and that you rename the jreviews_overrides folder to something else and clear the file registry before you upgrade.

The upgrade doesn't work, what now?

Enable FTP Layer in Joomla Global Configuration and try again. If that doesn't help, use your ftp client to temporarily modify the permissions of the Joomla /tmp folder to 777 and do the same with the components' administrator and frontend folders. For example /administrator/components/com_jreviews and /components/com_jreviews.

You can also use the regular upgrade method described below.

Manual upgrade

  1. If you are upgrading your production server it's always a good idea to perform a full backup of your site, including database and files, in case you need to revert the upgrade. A useful Joomla extension for this is Akeeba Backup.
  2. Backup your JReviews theme and other files if you made changes to them. It is not necessary to do this if you are using JReviews Code Overrides feature to put modified files outside the /components/com_jreviews folder.
  3. Go to the Joomla Extensions Manager and uninstall both S2Framework and JReviews components.
  4. Install new versions of S2 Framework and JReviews Component.
  5. Re-upload your modified JReviews theme files (only if you are upgrading from a minor release, otherwise your old theme files might not be up to date).
  6. Clear the browser cache! Otherwise you may end up with non-working links.

Upgrading to JReviews 2.7 from earlier versions

Read Upgrading to JReviews 2.7

Troubleshooting a broken upgrade

The most important thing to do when an upgrade presents broken functionality is to test the same function without any theme or code changes. If you use the code overrides functionality, you should rename the jreviews_overrides folder and clear the file registry. If the issue is solved, it means you need to update your modified files to bring them up to date with their most recent versions.

If you have made any theme or code changes read What happens with modified files when JReviews is upgraded