Latest revision as of 18:21, 31 January 2023

The Automatic Update utility allows admins to update WHMCS quickly and easily from directly within the Admin Area.

You can access this feature at Utilities > Update WHMCS.

For more information on the way in which updates change files, see Updater File Changes.

System Requirements

WHMCS has several system requirements for automatic updates:

• A PHP memory limit of at least 128MB.
• At least 250 MB of free disk space.
• The PHP allow_url_fopen setting is enabled.
• The PHP max_execution_time setting is 60 seconds or more.
• The PHP Zip Extension or the proc_open PHP function are enabled.
• The PHP open_basedir setting includes the entire WHMCS document root.

Configuring Your Update Settings

Update Channel

The Automatic Updater allows you to choose the update channel for the least stable version you are willing to update to:

Patch and Maintenance Release Updates

If you are on a WHMCS version that is in Long Term Support and we issue a patch for that version, you can use the Automatic Updater to apply the patch without moving to a newer WHMCS version.

To do this:

1. Select the Current Version update channel (see above).
2. Click Check for Updates to refresh the available version.
3. Proceed with your update as usual.

Temporary Update Path

The temporary path allows you to stage files during an update. For security reasons, ensure that this directory is outside of the public document root, like the attachments, downloads, and templates_c directories.

• The path must be an absolute path (for example, /home/username/tmp instead of ~/tmp).
• The path must be writable by the user that is running PHP.

Maintenance Message

Use this option to set a message to display to other admins and users whenever an update is in progress.

Checking for Updates

The system automatically checks for updates periodically. When an update becomes available, a notification will appear in the Admin Area.

Manually checking for updates

You can check for updates on demand by clicking Check for Updates. You may need to do this to see recent releases prior to the next automated check.

For a step-by-step tutorial, see Checking for Updates Manually.

Performing an Update

To perform an update:

1. Make certain that your server meets the system requirements and review the Release Notes for any important notices and information.
2. Make a full backup of your current installation.
3. In WHMCS, click Update Now.
   This option only displays if an update is available for your current update channel.
4. Follow the prompts to complete the update process. The update process can take anywhere from 30 seconds to a few minutes to complete.
5. Perform the necessary steps for your customizations:
   • If you use any custom file permissions, you must update the relevant files (for example, for /crons/pipe.php).
   • If you have custom template files, review and update your custom templates using the Template Changes section of the release notes.

Troubleshooting

You can find the log of Automatic Updater actions in the tblupdatelog table in the WHMCS database. To troubleshoot upgrade problems, review this table for the most recent entries (the highest id values). You can use a tool like phpMyAdmin to browse the table's contents.

For more information on troubleshooting update issues, see Upgrading New Installation Prompt and our update troubleshooting guides.

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 you need to select an update channel.

To fix this issue:

1. Click Configure Update Settings.
2. Select one of the four available update channel options (see above).
3. Click Save Changes.

Permission Errors

Permission errors in the update log may resemble the following examples:

• [WHMCS\Exception] Failed to perform early file copy during WHMCS file relocation: init.php
• [RuntimeException] /path/to/whmcs/whmcs does not exist and could not be created.
• failed to open stream: Permission denied
• Apply update dry-run detected 1 permission issues

The exact file permission and ownership issues depend on the individual server configuration. However, for a standard cPanel & WHM server using the suPHP PHP handler, the following configuration would be an appropriate POSIX file permissions:

• configuration.php — 400
• /crons/pipe.php — 755
• All other PHP files — 644
• All directories — 755

The file ownership and group should be the same as the user directory name. For example, on a cPanel & WHM server with a web root at /home/username/public_html/, username would own the files and the group would also use the name username.

Finally, the owner and group of the PHP process must be the same as the user directory name. For example, on a cPanel & WHM server with a web root at /home/username/public_html/, the PHP process owner and group would both be username.

Other types of server and PHP handlers may have different configuration requirements.

Unable to connect to the WHMCS Update Server

This error indicates that your server could not connect to the WHMCS update server.

You may see it in two locations:

• While attempting an automatic update.
• In the Activity Log section at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Activity Log.

To resolve this, attempt the following cURL connections from your server's command line:

If these commands succeed, they will return StatusCode: 200. If they do not, ask your hosting provider or system administrator to investigate the connectivity problem between your server and the WHMCS update server.