Difference between revisions of "Upgrading"
(→Performing an Upgrade) |
|||
| Line 12: | Line 12: | ||
If you choose to upgrade yourself, please follow the instructions below and in the release notes for the specific version to ensure a successful upgrade. | If you choose to upgrade yourself, please follow the instructions below and in the release notes for the specific version to ensure a successful upgrade. | ||
| − | You can upgrade from '''any''' WHMCS version from 3.2 onwards to the latest. You '''do not''' need to | + | You can upgrade from '''any''' WHMCS version from 3.2 onwards to the latest. You '''do not''' need to apply individual updates made between your currently installed version and the latest in order to upgrade. Instead you just need to download the latest full release package from our members area and then follow the upgrade instructions detailed below. |
| − | + | ==Downloading the Latest Version== | |
| − | #Begin by logging in to the | + | #Begin by logging in to the members area @ https://www.whmcs.com/members/clientarea.php (Note: If you do not have a login for our members area, this indicates your key has been obtained via a reseller and they should provide the latest WHMCS files to you) |
#Navigate to '''Services > Licenses & Services''' | #Navigate to '''Services > Licenses & Services''' | ||
#Select one of your active license keys and click '''View Details''' | #Select one of your active license keys and click '''View Details''' | ||
| Line 22: | Line 22: | ||
#The latest stable release can then be downloaded using the large green "Download Now" button | #The latest stable release can then be downloaded using the large green "Download Now" button | ||
| − | == | + | ==Upgrade Steps== |
| − | The steps needed to upgrade WHMCS | + | The steps needed to upgrade WHMCS always the remain the same from version to version. However some updates may require additional steps which are unique to them. Should these be required you will find them in the [[Release Notes]]. Please always refer to the release notes for a version before attempting any upgrade. |
| − | + | '''Backup Backup Backup - We cannot stress enough how important it is to *always* take a full backup before attempting any kind of upgrade. Both for WHMCS and any other software you use. A full backup should be taken of both the WHMCS files and the database.--- | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | Remember: If you have customised templates, always follow the recommended method for [[Client_Area_Template_Files#Creating_a_Custom_Template|creating a custom template folder]] to ensure your changes aren't overwritten during upgrades. Similarly for language customisations please ensure you use the [[Language Overrides]] feature vs editing the language files directly. | |
| − | + | #Begin by obtaining the latest full release download of WHMCS as described above | |
| + | #Unzip the contents of the WHMCS zip file download to a folder on your computer | ||
| + | #Upload the new files to your existing installation folder replacing any existing folders & files ''(If you have customised your WHMCS admin folder name, be sure to upload the admin folder updates to your custom folder name. Similarly, if you have customised the location of the /crons/ directory, be sure to upload that to the custom location.)'' | ||
| + | #Next visit the admin area as you normally would to login and you will then be automatically redirected to the upgrade script. If you see a message saying WHMCS is not installed, this indicates you have overwritten the configuration.php file for your installation. Stop and restore that file from your backup before continuing. | ||
| + | #Agree to the WHMCS End User License Agreement and follow the steps on screen to upgrade your database. | ||
| + | #When prompted, delete the install folder from your server. | ||
| + | #Your upgrade is now complete. | ||
| + | |||
| + | At this stage, typically in any Feature or Maintenance releases you will need to apply any of the new or changed template files to your custom template folder(s). Please refer to the [[Release Notes]] of the version you are upgrading to for an itemized list of template changes. | ||
| + | |||
| + | ==Tips & Tricks== | ||
| + | |||
| + | '''Bad Formatting''' | ||
| + | If when you first login you see a display where formatting is mixed or unclear, this can indiciate your browser cache has not updated. Try clearing your browser cache or performing a hard refresh (typically Ctrl + F5) and delete the contents of the template cache directory (''templates_c'' by default) to ensure you see the new templates and styling. | ||
Revision as of 13:26, 20 November 2013
We aim to make upgrading WHMCS as simple as possible. Below we hope to provide everything you might need in order to successfully and confidently update your WHMCS installation.
Contents
Upgrade Service
We offer a professional upgrade service where our staff will upgrade your WHMCS installation for you. Please refer to http://www.whmcs.com/services/upgrade-service/ for more information and to order that.
Manually Upgrading
If you choose to upgrade yourself, please follow the instructions below and in the release notes for the specific version to ensure a successful upgrade.
You can upgrade from any WHMCS version from 3.2 onwards to the latest. You do not need to apply individual updates made between your currently installed version and the latest in order to upgrade. Instead you just need to download the latest full release package from our members area and then follow the upgrade instructions detailed below.
Downloading the Latest Version
- Begin by logging in to the members area @ https://www.whmcs.com/members/clientarea.php (Note: If you do not have a login for our members area, this indicates your key has been obtained via a reseller and they should provide the latest WHMCS files to you)
- Navigate to Services > Licenses & Services
- Select one of your active license keys and click View Details
- Now select the Downloads tab
- The latest stable release can then be downloaded using the large green "Download Now" button
Upgrade Steps
The steps needed to upgrade WHMCS always the remain the same from version to version. However some updates may require additional steps which are unique to them. Should these be required you will find them in the Release Notes. Please always refer to the release notes for a version before attempting any upgrade.
Backup Backup Backup - We cannot stress enough how important it is to *always* take a full backup before attempting any kind of upgrade. Both for WHMCS and any other software you use. A full backup should be taken of both the WHMCS files and the database.---
Remember: If you have customised templates, always follow the recommended method for creating a custom template folder to ensure your changes aren't overwritten during upgrades. Similarly for language customisations please ensure you use the Language Overrides feature vs editing the language files directly.
- Begin by obtaining the latest full release download of WHMCS as described above
- Unzip the contents of the WHMCS zip file download to a folder on your computer
- Upload the new files to your existing installation folder replacing any existing folders & files (If you have customised your WHMCS admin folder name, be sure to upload the admin folder updates to your custom folder name. Similarly, if you have customised the location of the /crons/ directory, be sure to upload that to the custom location.)
- Next visit the admin area as you normally would to login and you will then be automatically redirected to the upgrade script. If you see a message saying WHMCS is not installed, this indicates you have overwritten the configuration.php file for your installation. Stop and restore that file from your backup before continuing.
- Agree to the WHMCS End User License Agreement and follow the steps on screen to upgrade your database.
- When prompted, delete the install folder from your server.
- Your upgrade is now complete.
At this stage, typically in any Feature or Maintenance releases you will need to apply any of the new or changed template files to your custom template folder(s). Please refer to the Release Notes of the version you are upgrading to for an itemized list of template changes.
Tips & Tricks
Bad Formatting If when you first login you see a display where formatting is mixed or unclear, this can indiciate your browser cache has not updated. Try clearing your browser cache or performing a hard refresh (typically Ctrl + F5) and delete the contents of the template cache directory (templates_c by default) to ensure you see the new templates and styling.