Joomla! Documentation™

Under Construction

It is risky to upgrade a live site without testing the upgrade process first. So before upgrading the live site you need to set up a test site which is as close as possible to the configuration of your live site, then test the upgrade on that. When you are happy with the process you can apply it to the live site (having taken a fresh backup of the live site first, of course).

Step 1: Download the correct patch package

Determine the current version of your Joomla! installation. For example, if you currently have version 1.0.13 installed you will need to download the 1.0.13 to 1.0.14 RC1 patch package. The patch packages are available on JoomlaCode.org. Each patch package is available in three different package formats. These are indicated by the file extension which is either .zip, .tar.gz or .tar.bz2. The contents of each of these alternative packages is identical so just choose the one most convenient for you. There is more information on package formats if you are not sure which to select.

For example, if you are upgrading from 1.0.13 to 1.0.14 RC1 and you would prefer the .tar.gz package format, then select the file named Joomla_1.0.12_to_1.0.14RC1-Patch_Package.tar.gz

Please note that for the Release Candidate(s) we are not providing patch packages for versions prior to 1.0.12. The full range of patch packages will be provided when 1.0.14 Stable is released.

Step 2: Make a copy of your live site

Ideally this should be on the same platform (operating system, PHP and database version) as the live site, but don't worry if this is not possible. Making a working copy of a Joomla! website involves copying the files and the database (these are separate activities). You will then need to amend the configuration.php to reflect the new location. If you are not familiar with the process of copying a Joomla! website then refer to the copying instructions.

Step 3: Install the patch package on the copy site

There are different ways of installing a package file depending on your particular circumstances. If you have difficulty with one of these methods, then simply try another.

• Alternative 1: Unpack the package file on your local computer then use an FTP client to upload them to your site.

• Alternative 2: Use an FTP client to upload the package to your site, then use a terminal session (eg. SSH) to connect to your site and unpack the files there.

• Alternative 3: If your hosting provider gives you access to your site via some sort of web control panel like CPanel or Plesk, you can use the control panel file manager to upload the package, then use a terminal session (which might also be available via the control panel) to unpack the package file and overwrite all changed files on the server.
  • If you are using CPanel, there is specific information on Uploading and extracting an archive file with CPanel.

Step 4: Test thoroughly

Check out as much of the functionality on your test site as possible. If there are any problems that will affect the way that you will need to handle the live upgrade then make a written note of them for later.

If you find errors you might check out the following possibilities:

• Ensure that all of the patch files were properly transferred. There have been verified reports of some FTP clients not properly transferring files across to a server without notifying the user of such a problem. One possible cause of this problem is that under certain circumstances the web server locks the files it is using and the FTP-server can't update those files. If this is the case you might try taking the site offline shortly during the FTP transfer.

Step 5: Backup your live site

Take a full backup copy of your live site immediately prior to upgrading. You may want to take your site offline prior to doing this so that updates are not lost. If you are not familiar with the process of copying a Joomla! website then refer to the copying instructions.

Step 6: Install the patch package on your live site

There are different ways of installing a package file depending on your particular circumstances. If you have difficulty with one of these methods, then simply try another.

• Alternative 1: Unpack the package file on your local computer then use an FTP client to upload them to your site.

• Alternative 2: Use an FTP client to upload the package to your site, then use a terminal session (eg. SSH) to connect to your site and unpack the files there.

• Alternative 3: If your hosting provider gives you access to your site via some sort of web control panel like CPanel or Plesk, you can use the control panel file manager to upload the package, then use a terminal session (which might also be available via the control panel) to unpack the package file and overwrite all changed files on the server.
  • If you are using CPanel, there is specific information on Uploading and extracting an archive file with CPanel.

The alternative selected may be different from that used in step 3 if the hosting platform for the site is different.

Step 7: Make any other changes required

Referring to your notes from step 4, make any other changes that are required to bring the site into operation following the patch installation.

Step 8: Check your live site to make sure it is working correctly

Don't assume that the upgrade will work flawlessly just because the test upgrade worked. Check to make sure that nothing untoward has happened. It could be that differences between the live site and test site platforms will bring out a problem that you did not notice during testing. If you find a problem and it cannot be resolved quickly you might have to rollback the upgrade using the backup copy you created in step 5.

Hopefully all will be well and you can relax. If you have any questions before, during, or after the upgrade then please ask them on the Joomla! 1.0 Upgrading 1.0.x Forum.