Revision as of 09:45, 26 June 2020

The Automatic Update utility allows admin users to update WHMCS quickly and easily in just a few clicks.

System Requirements

For automatic updates to be possible, the following system requirements apply:

• A PHP Memory limit of at least 128MB
• At least 250 MB of free disk space
• PHP setting allow_url_fopen enabled
• PHP max_execution_time in excess of 60 seconds
• PHP Zip Extension or the proc_open PHP function enabled
• PHP setting open_basedir to include entire WHMCS docroot

Configuring Your Update Settings

Choosing an Update Channel

The WHMCS automatic updater allows you to choose an update channel that defines the type of updates you will receive. The update channel setting determines the least stable version you are willing to update to:

Patch and Maintenance Release Updates

• If you are on a version that is in Long Term Support and a patch is issued for that series, you can use the Updater to apply the patch and remain on that series.
• To do this, select the Current Version update channel as described above.
• You many need to click Check for Updates after any setting changes in order to refresh the available version displayed within the page.

Setting a Temporary Update Path

A temporary path is required for staging of files during an update. For security reasons it is recommended that this directory be located outside the public doc root, similar to the attachments, downloads and templates_c directories. The path must be an absolute path (i.e. /home/whmcsuser/tmp instead of ~/tmp) and must be writable by the user that is running PHP.

Setting a Maintenance Message

This option can be used to set a message that will be displayed to both other admin and client users whenever an update is in progress.

Checking for Updates

New updates are checked for periodically automatically.

When an update becomes available, a notification will appear in the top left corner of admin area as shown below.

Manually checking for updates

You can check for updates on-demand by navigating to Utilities > WHMCS Update and clicking the Check for Updates button.

If a release has just been published you may need to do this to see the update as available prior to the next automated check.

For Owned licenses, the version fetched by the utility will be the version of WHMCS that was available when your Support and Updates Subscription was active. Downloading the latest version of WHMCS requires an active Support and Updates Subscription.

Performing an Update

1. Begin by making sure your server meets the system requirements,
2. Before beginning any update, it is strongly recommended to make a full backup of your current installation and review the Release Notes for any important notices and information.
3. To perform an update, navigate to Utilities > Update WHMCS and click the Update Now button (pictured above).
   Please note this option will only show if an update is available based on your current Update Channel Preferences.
4. You will then be guided through the update process. The update process can take anywhere from 30 seconds to a few minutes to complete.
5. Once completed a message is displayed on-screen. If you have custom template files you will also need to review and make any necessary changes to your custom templates using the information provided in the Template Changes section of the Release Notes.

Watch the video tutorial for this feature  

Troubleshooting

The actions performed by the Automatic Updater are recorded in the tblupdatelog table within the WHMCS database. To troubleshoot upgrade problems it is useful to review this table for the most recent entries (the highest id values). A tool such as phpmyadmin can be used to browse to the table contents.

Additional guides to troubleshooting auto-update problems are located at http://help.whmcs.com/m/updating

Please ensure you have selected a valid Update Channel and then try again

Receiving this error message in the cron job report email or activity log, indicates that an Update Channel setting needs selecting. To do this, navigate to Utilities > Update WHMCS and click Configure Update Settings.

Next select one of the four available update channel options, and Click Save Changes. The options are described above.

Permission Errors

Permission errors may manifest themselves in the tblupdatelog table as the following:

or

or

These kinds of file permission and ownership issues are multi-faceted and dependant upon the individual server configuration. However for a standard cPanel server using the suPHP PHP Handler an appropriate posix file permissions permissions would be:

The file ownership and group should be the same as the user directory name. Eg. On a cPanel box where the web-root is located at /home/david/public_html/, files should be owned by david, and the group should be david.

Finally, the owner and group of the PHP process seeking to take action should be the same as the user directory name. Eg. On a cPanel box where the web-root is located at /home/david/public_html/, PHP process owner and group should be david.

Other types of server and PHP handlers may have different configuration requirements, the above is intended as a guide for one particular possible combination only.

Curl 77 Error

CURL77 errors may manifest as the following in the tblupdatelog table:

[WHMCS\Installer\Composer\ComposerUpdateException] Failed to get certificate metadata from keyserver. Error: Unable to download file from URL:  Message cURL error 77: Problem with the SSL CA cert (path? access rights?) update [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--lock] [--no-plugins] [--no-custom-installers] [--no-autoloader] [--no-scripts] [--no-progress] [--with-dependencies] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader] [-a|--classmap-authoritative] [--ignore-platform-reqs] [--prefer-stable] [--prefer-lowest] [-i|--interactive] [--root-reqs] [--] []...

This error indicates that the server was unable to connect to the WHMCS update server because the security of the connection could not be verified. The connection is secured using SSL certificates and to verify the certificate your server needs up-to-date root certificates to know which to trust.

Please work with your server administrator or hosting provider to ensure the root CA bundles are fully updated on your server.