Updating

From WHMCS Documentation

Revision as of 22:42, 11 March 2022 by SarahK (talk | contribs)

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 have access to the following privileges:

  • ALTER
  • CREATE
  • DROP
  • INDEX

Additionally, make certain that the database user has access to all of the privileges on the Further Security Steps page.

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 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 two ways: Full Release distributions and Patch Set distributions.

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

Patch Set distributions 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.

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..." 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 Full Release version and update using the regular update process above.