Chapter 2 Installation & Upgrade

2.1 Downloading the latest JReviews package

To access your license downloads, log in on our website and then go to the Client Area.

If you can't access the client area after log-in and instead you see a message saying you are already logged in you can try using a different browser or use this alternate link to log in.

In the Client Area click the View Your Licenses link on the left menu and then click the View & Download button:

On the next page you will see your license details and available downloads:

You will be able to download the latest version as long as you have a valid upgrades package. You get 12 months of free upgrades. After expiration you need to renew the upgrades if you want to download the most recent version.

2.1.1 Downloading JReviews Add-ons

There is no download link for JReviews Add-ons, they can be installed directly from JReviews administration!

2.2 Pre-install requirements

2.2.1 CMS Requirement

JReviews is compatible with:

2.2.2 PHP Requirement

Required PHP version is 5.2.x or higher.

Required PHP Extensions: json, mbstring, curl, bcmatch (most servers have them installed by default).

PHP Configuration:

2.2.3 IonCube

IonCube loader needs to be installed and enabled on your server. On some hosting packages it is enabled by default.

If ionCube is not enabled on your server, you can ask your host to install it for you, or you can do that yourself:

  1. Download loaders package from ionCube website.

  2. Upload ioncube_loader_lin_5.3.so file (if your server uses PHP 5.3) or ioncube_loader_lin_5.4.so file (if your server uses PHP 5.4) anywhere in your joomla folder.

  3. Create the /administrator/php.ini file and add this line (use the correct path to the ioncube file where you uploaded it):

    zend_extension=/path/to/ioncube/folder/ioncube_loader_lin_5.3.so
    

Note: If you are having troubles installing ioncube, download loader-wizard.zip file, extract the zip and place the loader-wizard.php file into the root of your site. Run that file and it will guide you through the installation process.

Watch a "How to check JReviews pre-install requirements" video tutorial on YouTube

2.3 Installing JReviews

First extract the JReviews package that you downloaded from the Client Area (package_jreviews_2.4.x_unzip_first.zip).

This is the folder structure of the package:

2.3.1 Installation Steps

  1. Make sure that the Joomla debug mode is disabled in Joomla global configuration, system tab.
  2. In the Joomla Administration click on Extensions -> Extension Manager menu.
  3. In the Install tab click Browse and locate the S2Framework component package - com_s2framework_1.5.zip.
  4. Click the Upload & Install button.
  5. After the S2 Framework is installed, click Browse again and locate the JReviews component package - com_jreviews_2.4.zip.
  6. Click Upload & Install.
  7. Next you'll see a link Click here to continue with the installation.
  8. After the installation is finished, you'll get a Click here to go to the component page link.
  9. On the next screen enter your License Number.
  10. Click Submit and JReviews is ready to use.

JReviews modules and plugins will be installed automatically.

2.4 Upgrading JReviews

2.4.1 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.

2.4.2 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 inside /components/com_jreviews/ 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.

2.4.2.1 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.

2.4.3 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 S2Framework 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.

2.4.3.1 Upgrading to JReviews 2.4 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.

  1. Create a development site first to test the upgrade. You can use website cloning tools like Akeeba Backup for this purpose.
  2. Uninstall GeoMaps and PaidListings add-ons via Install & Update page in JReviews administration.
  3. 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.
  4. Uninstall the S2Framework and JReviews components.
  5. Download the package from the client area, your upgrades need to be valid or you need to order a new upgrades package.
  6. Install the new S2Framework and JReviews and CLEAR the browser cache.
  7. If you have a GeoMaps, PaidListings or WidgetFactory license, install them from the remote installer in JReviews and CLEAR the browser cache.
  8. 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.

2.4.3.2 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