Difference between revisions of "How to upgrade JReviews"

From JReviews Documentation
Jump to: navigation, search
(Upgrading the licensed version)
(Remote Update)
 
(49 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__TOC__
 
__TOC__
  
== Upgrading the licensed version ==
+
== What happens to my existing listings, reviews and customizations when I upgrade ==
  
Before you start the upgrade process it is important to note that upgrading JReviews does not remove your configuration settings, nor 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 taken care off automatically for you.
+
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.  
  
If you've made any theme or code changes, you must have a backup.
+
== Remote Update ==
  
'''JReviews versions 2.1.9 or later'''
+
You can do a one-click remote update by using the '''Install & Update''' menu in the JReviews administration under the Maintenance header on the left column. Always update the s2framework first and JReviews second.
  
You can do a one-click remote upgrade by using the installer/upgrader 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 update. You can use the [[JReviews Code Overrides]] to move the files outside the core folders to prevent them from being overwritten.
  
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 update first and that you rename the jreviews_overrides folder to something else and clear the file registry before you update.'''
  
'''JReviews versions 2.1.5 or earlier'''
+
=== The update doesn't work, what now? ===
  
#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.
+
If you get a blank page or are not able to see any options to update, [[I am not able to use the remote install and updates page to update JReviews or install add-ons|read this article]].
#Backup your JReviews theme and other files if you made changes to them. If you are using [[JReviews Code Overrides]] feature to put modified files outside com_jreviews folder, then it is not necessary.
+
#Uninstall both S2 Framework and JReviews Component
+
#Install new versions of S2 Framework and JReviews Component
+
#Re-upload your modified JReviews theme files. If you are moving between major versions (i.e. JReviews 2.0 to JReviews 2.1), keep in mind that your themes will not necessarily work with the new version and don't have all of the functionality in them. It is recommended that you transfer your changes to the new theme files.
+
#Unzip the module files and replace the existing ones in the /modules directory. No need to uninstall/reinstall which would require you to setup your modules all over again. You might need to go into each module and adjust the setting parameters if something isn't right, there are many new configuration options in all modules.
+
#Clear the browser cache! Otherwise you may end up with non-working links.
+
  
== Upgrading from trial version to licensed version ==
+
Otherwise, for Joomla users, try enabling 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.
  
'''JReviews versions 2.1.9 or later'''
+
Finally, you can also use the regular update method described below.
  
Before you do the upgrade, go to the license screen and replace the trial license number with the full version license number.
+
== Manual upgrade ==
  
You can do a one-click remote upgrade by using the installer/upgrader menu in the JReviews administration under the Maintenance header on the left column. Always upgrade the s2framework first and JReviews second.
+
# 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.
 +
# 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.
 +
# Go to the '''Joomla Extensions Manager''' and uninstall both S2Framework and JReviews components.
 +
# Install new versions of S2 Framework and JReviews Component.
 +
# 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).
 +
# Clear the browser cache! Otherwise you may end up with non-working links.
  
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.
+
== Upgrading to JReviews 2.7 from 2.5 and older ==
  
'''JReviews versions 2.1.5 or earlier'''
+
Read [[Upgrading to JReviews 2.7]]
  
*Simply submitting the full license number does not decode your trial version and convert it to a full version.
+
== Troubleshooting a broken upgrade ==
*You must download and install the full version in order to remove all license checks from the front-end of your site so your users are never affected by encoding or license related issues.
+
 
*The trial version has the same functionality as the licensed version, but it is encoded in the front-end as well so that when the trial expires jReviews stops working.
+
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.
*To convert your trial to a licensed version you need to follow the steps above
+
 
 +
If you have made any theme or code changes read [[What happens with modified files when JReviews is upgraded]]
  
  
 
[[Category:JReviews]]
 
[[Category:JReviews]]
 
[[Category:Upgrade]]
 
[[Category:Upgrade]]
[[Category:Trial]]
 

Latest revision as of 22:09, 30 September 2019

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 Update

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

Remember to backup any files you've customized because they will be replaced during the update. 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 update first and that you rename the jreviews_overrides folder to something else and clear the file registry before you update.

The update doesn't work, what now?

If you get a blank page or are not able to see any options to update, read this article.

Otherwise, for Joomla users, try enabling 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.

Finally, you can also use the regular update 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 2.5 and older

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