|
|
| (39 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | The below documentation is designed to allow you to both confidently and successfully update your WHMCS installation. We always recommend staying up-to-date with WHMCS in order to benefit from the latest development and improvements, and you can do that either by [http://www.whmcs.com/services/upgrade-service/ having us perform the upgrade for you] or by updating as per the steps below.
| + | #REDIRECT [[updating]] |
| − | | |
| − | ==Performing an Upgrade==
| |
| − | | |
| − | [[File:Videotutorial.png|center|link=http://www.youtube.com/watch?v=wXZpPjPxvfY&hd=1|Watch Video Tutorial]] | |
| − | | |
| − | | |
| − | 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.
| |
| − | | |
| − | You can upgrade automatically from '''any''' WHMCS version later than 3.2.0. If you have missed a few upgrades, you can always upgrade to the very latest version using the full release distribution (More Info on our [[Releases|Release Types]] can be found [[Releases|here]]).
| |
| − | | |
| − | ==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==
| |
| − | | |
| − | ===For a Full Release Version===
| |
| − | | |
| − | '''Make a Full 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.'''
| |
| − | | |
| − | #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 ''(Note: 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.)''
| |
| − | #Visit your WHMCS installation and you should then be automatically redirected to the upgrade process. 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, the installation update is complete. However, if you have custom template files you will want to review the Release Notes again so that you know which templates, if any, were updated and act accordingly to propagate these changes to your customised template set.
| |
| − | | |
| − | ===For a Patch Set===
| |
| − | | |
| − | Patch Sets are often provided containing only the files that have changed between the immediately previous release and the Patch Set Version. We provide these to make updating both quicker and easier for those of our customers who stay current and up-to-date with the latest WHMCS releases. By including only the changed files, patch sets have less files to upload which makes the upgrade process quicker and simpler for you to perform.
| |
| − | | |
| − | A patch set will always include _patch within the zip folder filename to indicate they are a patch rather than full release version.
| |
| − | | |
| − | '''IMPORTANT:''' Before you begin please ensure you are running the version required by the patch. Patch Sets contain only the files that have changed between the previous release and the Patch Set Version. Therefore they should only be applied if you are running the immediately previous version.
| |
| − | | |
| − | The previous release version that these patch sets are designed for is clearly indicated as the first and smaller number in release notices providing the patch set download link.
| |
| − | | |
| − | #Download the patch set using the link provided in the release announcement
| |
| − | #Unzip the patch set files
| |
| − | #Upload the files from the /whmcs/ directory to the root directory of your WHMCS installation
| |
| − | #Visit the admin area of your WHMCS installation to trigger the version number bump and complete the process
| |
| − | | |
| − | No install or upgrade process is required.
| |
| − | | |
| − | ==Helpful Hints==
| |
| − | | |
| − | '''Customisations'''
| |
| − | | |
| − | If you have customised templates, please ensure you 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 file customisations please ensure you use the [[Language Overrides]] feature vs editing the language files directly.
| |
| − | | |
| − | '''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.
| |
| − | | |
| − | ==Need Help? We're here...==
| |
| − | | |
| − | 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.
| |
| − | | |
| − | And of course our support team is always available to answer any questions or concerns you might have about performing the upgrade process yourself. Simply open a ticket @ http://www.whmcs.com/get-support/ and a member of our team will get back to you.
| |