Difference between revisions of "Updating"

Latest revision as of 21:47, 8 February 2023

Update Service: Have our team update your installation.Services

We always recommend staying up-to-date with WHMCS in order to benefit from the latest development and improvements. You can do this by having us perform the update for you or by updating using one of our supported methods.

Our support team is always available to answer any questions or concerns you might have when performing updates. Open a ticket and a member of our team will assist you.

Preparing for Updates

Preparation helps to ensure a seamless updating experience. For more information, see Get WHMCS Download Information and our recommendations for preparation, testing, and execution of WHMCS updates.

Database Privileges

Updating requires that the database user has access to the required privileges.

For more information and a list of required privileges, see System Environment Guide.

Customisations

If you have customised templates, make sure to follow the recommended method for creating a custom template folder to ensure your changes aren't overwritten during updates.

For language file customisations, make sure that you use the Language Overrides feature instead of editing the language files directly.

Updating in the Admin Area

WHMCS 7.0 and later includes a way to update WHMCS from within the Admin Area.

To do this, go to Utilities > Update WHMCS. For more information, see Automatic Updater.

If we released an update recently, you may need to click Check for Updates before the update will display.

Updating Manually

You can also update your WHMCS installation manually using one of two methods:

You can use FTP or your hosting control panel's file management system to manage the necessary files. For more information, see Updating WHMCS Manually.
If you are comfortable running commands on the server that hosts your WHMCS installation, you can make the necessary changes on the command line. For more information, see Install On The Command Line.

Distributions

We distribute WHMCS in Full Release and Patch Set distributions. You can identify the distribution type by examining the distribution's .zip file and the contents of the included README.txt file:

Distribution Type	`.zip` Filename Contains	`README.txt` File Contains	Files Included	Use For
Full Release	`_full`	`Distro Type: Full Version`	All files for an installation.	New installations or updates to an existing installation (regardless of previous version).
Patch Set	`_patch`	`Distro Type: Patch Set`	Only files changed since the immediate previous version.	Updates to an existing installation that has stayed up-to-date with the latest WHMCS releases.

For example, we would recommend using a Full Release distribution to move from an End-of-Life version to the newest release. You could only use a Patch Set distribution if you were moving from the immediately previous release to the newest release.

For more information on our release and distribution types, see Releases.

Troubleshooting

You may encounter the following issues during an update:

Bad Formatting

If, when you first log in, you see a mixed or unclear formatting, your browser may not have 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 that you see the new templates and styling.

Down for Maintenance or Update in Progress

If, after uploading the files from a Patch Set, you see a Down for Maintenance or update in progress... message, the patch set files you attempted to apply are not compatible with the version of WHMCS you were previously running.

To complete the update, download the latest Full Release version and update using the regular update process above.

@@ Line 1: / Line 1: @@
-We always recommend staying up-to-date with WHMCS in order to benefit from the latest development and improvements. You can do this by [https://www.whmcs.com/services/upgrade-service/ having us perform the update for you] or by updating using the steps below.
+<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Update Service:</b> Have our team update your installation.</small></em><span class="button">Services</span></a></html>
-<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small>Have our professional services team update your installation.</small></em><span class="button">Services</span></a></html>
+We always recommend staying up-to-date with WHMCS in order to benefit from the latest development and improvements. You can do this by [https://www.whmcs.com/services/upgrade-service/ having us perform the update for you] or by updating using one of our supported methods.
-==Automatic Updating==
+Our support team is always available to answer any questions or concerns you might have when performing updates.  [http://www.whmcs.com/get-support/ Open a ticket] and a member of our team will assist you.
-If you are running WHMCS 7.0 or later, you can use the built-in Automatic Update utility. To do this:
+==Preparing for Updates==
-* Navigate to '''Utilities > Update WHMCS''' to begin the process.
+Preparation helps to ensure a seamless updating experience. For more information, see [[Get WHMCS Download Information]] and our recommendations for [https://blog.whmcs.com/133532/our-top-tips-for-a-seamless-update preparation, testing, and execution of WHMCS updates].
-* Click ''Update Now''.
-* Follow the prompts through the update process.
-[[File:UpdateAvailable.png|center]]
+===Database Privileges===
+Updating requires that the database user has access to the required privileges.
-<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>&nbsp; If we released an update recently, you may need to click ''Check for Updates'' before the update will display.</div>
+For more information and a list of required privileges, see [[System_Environment_Guide#Database_Privileges|System Environment Guide]].
-For more information about the Automatic Updater and troubleshooting, see [[Automatic Updater]].
+===Customisations===
-==Performing a Manual Update==
+If you have customised templates, make sure to 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 updates.
-[[File:Videotutorial.png|center|link=http://www.youtube.com/watch?v=wXZpPjPxvfY&hd=1|Watch Video Tutorial]]
+For language file customisations, make sure that you use the [https://developers.whmcs.com/languages/overrides/ Language Overrides] feature instead of editing the language files directly.
-To update WHMCS manually, follow the steps in the section below. Some updates may require steps in addition to the standard update steps below.  We provide this information in the [[Release Notes]].  Always refer to the release notes for a version before attempting any update.
+==Updating in the Admin Area==
-A '''Full Release''' distribution contains all the files of a WHMCS product installation. You can use it to perform a new installation or update an existing installation (regardless of previous version).
+WHMCS 7.0 and later includes a way to update WHMCS from within the Admin Area.
-'''Patch Sets''' contain only the files that have changed between the immediate previous version and the latest version (for example, a patch set for version 1.1.2 is valid for a 1.1.1 installation and nothing else). 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 update process quicker and simpler for you to perform.
+To do this, go to '''Utilities > Update WHMCS'''. For more information, see [[Automatic Updater]].
-For more information on our release types and distribution types, see our [[Releases]] page. Advanced users can also perform upgrades [[Install_On_The_Command_Line|from the command line]].
+<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>&nbsp; If we released an update recently, you may need to click ''Check for Updates'' before the update will display.</div>
-==Update Steps==
-===For a Full Release Version===
-A full release version includes <tt>_full</tt> within the <tt>.zip</tt> folder filename and "Distro Type: Full Version" within the included <tt>README.txt</tt> file.  If the <tt>.zip</tt> filename contains <tt>_patch</tt>, see the [[Updating#For_a_Patch_Set|Patch Set update Steps]] section below.
-'''Make a Full Backup. We cannot stress enough how important it is to always create a full backup before attempting any kind of update, both for WHMCS and for any other software you use.  In your full backup, include both the WHMCS files and the database.'''
-To update for a full release version:
-#Make certain that your system meets our [[System_Requirements|system requirements]].
-#Obtain the latest full release download of WHMCS from http://download.whmcs.com/ or, if you use a reseller, from your license provider.
-#Unzip the contents of the downloaded WHMCS <tt>.zip</tt> file to a folder on your computer.<div class="docs-alert-danger"><span class="title">Custom Admin Directory?</span><br />If you have renamed your "admin" directory, rename the <tt>/whmcs/admin</tt> directory in the new files to match. </div><div class="docs-alert-warning"><span class="title">Custom Cron Directory?</span><br />If you have customised the location of the <tt>/crons/</tt> directory, be sure to upload that to the custom location.</div><div class="docs-alert-success"><span class="title">Custom File Permissions?</span><br />If you have customised the permissions on any of the files (for example, <tt>/crons/pipe.php</tt>). You must reapply these changes after the update is complete.</div>
-#Upload the new files to your existing installation folder, replacing any existing folders and files.
-#Visit your WHMCS installation. The system will automatically direct you to the update process. If the system doesn't auitomatically redirect you, visit the installation page directly at <tt>yourdomain.com/whmcs/install</tt>. If you see a message that states that you have not installed WHMCS, you may have overwritten the <tt>configuration.php</tt> 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 prompts to update your database.
-#When the system prompts you, delete the installation folder from your server.
-#Your update is now complete.
-We recommend that you check the release notes for the version you just installed [[Release_Notes|here]]. If you have custom template files, you will also need to review and make any necessary changes to your custom templates. For more information, see the Template Changes section of the [[Release_Notes|Release Notes]].
-===For a Patch Set===
-A patch set version includes <tt>_patch</tt> within the <tt>.zip</tt> folder name and "Distro Type: Patch Set" within the included <tt>README.txt</tt> file.
-'''IMPORTANT:''' Before you begin, make sure you are running the version that the patch requires. Patch Sets contain only the files that have changed between the previous release and the Patch Set Version. Only apply them if you are running the immediately-previous version.
-The previous release version that we designed these patch sets for is part of the first and smaller number in release notices providing the patch set download link.
-To update using a patch set:
-#Download the patch set from http://download.whmcs.com/.
+==Updating Manually==
-#Unzip the patch set files.<div class="docs-alert-danger"><span class="title">Custom Admin Directory?</span><br />If your patch set includes changes to the <tt>admin</tt> directory and you have renamed your "admin" directory, rename the <tt>/whmcs/admin</tt> directory in the new files to match. </div>
-#Upload the files from the <tt>/whmcs/</tt> directory to the root directory of your WHMCS installation.
-#Visit the admin area of your WHMCS installation to trigger the version number increment and complete the process.
-This method doesn't require an install or update process.
+You can also update your WHMCS installation manually using one of two methods:
-==Confirming a Successful Update==
+* You can use FTP or your hosting control panel's file management system to manage the necessary files. For more information, see [https://go.whmcs.com/1709/Updating-WHMCS-Manually Updating WHMCS Manually].
+* If you are comfortable running commands on the server that hosts your WHMCS installation, you can make the necessary changes on the command line. For more information, see [[Install On The Command Line]].
-To confirm that an update applied successfully, log in to your WHMCS admin area. Then, check to make sure that the version number on either the admin homepage (in the sidebar of all default templates) or in '''Help > System Health Status''' is the version that you attempted to apply. If it has not incremented, then one or more of the files has not uploaded successfully. Check your file permissions and attempt the steps again from the beginning.
+===Distributions===
-==Helpful Hints==
+We distribute WHMCS in '''Full Release''' and '''Patch Set''' distributions. You can identify the distribution type by examining the distribution's <tt>.zip</tt> file and the contents of the included <tt>README.txt</tt> file:
-'''Top Tips for A Seamless Update'''
+<table class="table table-striped table-condensed">
+<tr><th>Distribution Type</th><th><tt>.zip</tt> Filename Contains</th><th><tt>README.txt</tt> File Contains</th><th>Files Included</th><th>Use For</th></tr>
+<tr><td>'''Full Release'''</td><td><tt>_full</tt></td><td><tt>Distro Type: Full Version</tt></td><td>All files for an installation.</td><td>New installations '''or''' updates to an existing installation (regardless of previous version).</td></tr>
+<tr><td>'''Patch Set'''</td><td><tt>_patch</tt></td><td><tt>Distro Type: Patch Set</tt></td><td>Only files changed since the immediate previous version.</td><td>Updates to an existing installation that has stayed up-to-date with the latest WHMCS releases.</td></tr>
+</table>
-Preparation helps to ensure a seamless updating experience. For more information, see our recommendations for [https://blog.whmcs.com/133532/our-top-tips-for-a-seamless-update preparation, testing and execution of WHMCS updates].
+For example, we would recommend using a '''Full Release''' distribution to move from an End-of-Life version to the newest release. You could '''only''' use a '''Patch Set''' distribution if you were moving from the immediately previous release to the newest release.
-'''Database Privileges'''
+For more information on our release and distribution types, see [[Releases]].
-Updating requires that the database user have access to the following privileges:
-*<tt>ALTER</tt>
-*<tt>CREATE</tt>
-*<tt>DROP</tt>
-*<tt>INDEX</tt>
-Additionally, you will want to ensure that the database user have access to all of the privileges on the [[Further_Security_Steps#Restrict_Database_Privileges|Further Security Steps]] page.
-'''Customisations'''
+==Troubleshooting==
-If you have customised templates, make sure to 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 updates. Similarly, for language file customisations, make sure that you use the [https://developers.whmcs.com/languages/overrides/ Language Overrides] feature instead of editing the language files directly.
+You may encounter the following issues during an update:
-'''Bad Formatting'''
+===Bad Formatting===
 If, when you first log in, you see a mixed or unclear formatting, your browser may not have updated. Try clearing your browser cache or performing a hard refresh (typically <tt>Ctrl + F5</tt>) and delete the contents of the template cache directory (''templates_c'' by default) to ensure that you see the new templates and styling.
-'''What to do if you get a Down for Maintenance or update in Progress message after uploading a patch set'''
+===Down for Maintenance or Update in Progress===
-If, after uploading the files from a Patch Set, you see a "Down for Maintenance" or "update in progress..." warning message, then this indicates that the patch set files you attempted to apply are not compatible with the version of WHMCS you were previously running. To complete the update you will need to download the latest [[Updating#For_a_Full_Release_Version|Full Release]] version and update using the regular update process above.
-==We're here to help==
-We offer a professional update service where our staff will update your WHMCS installation for you. For more information and to order services, see https://www.whmcs.com/services/upgrade-service/.
+If, after uploading the files from a Patch Set, you see a '''Down for Maintenance''' or '''update in progress...''' message,  the patch set files you attempted to apply are not compatible with the version of WHMCS you were previously running.
-Our support team is always available to answer any questions or concerns you might have when performing updates.  Open a ticket at http://www.whmcs.com/get-support/ and a member of our team will assist you.
+To complete the update, download the latest [[Updating#For_a_Full_Release_Version|Full Release]] version and update using the regular update process above.

Documentation