Difference between revisions of "System Health Status"

From WHMCS Documentation

m (The Checks)
m (The Checks)
 
(8 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
Checks that the system cron has run to completion within the last 24 hours.  If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc...) or that the cron is failing to complete successfully.
 
Checks that the system cron has run to completion within the last 24 hours.  If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc...) or that the cron is failing to complete successfully.
  
If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. For further assistance, please contact our support team.
+
If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. Further helpful documentation regarding this check can be found [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#system_cron_tasks here]
 +
 
 +
For further assistance, please contact our support team.
  
 
'''Cron PHP Version Mismatch'''
 
'''Cron PHP Version Mismatch'''
Line 28: Line 30:
  
 
Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.
 
Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.
 +
 +
Please see this [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#permissions_check help guide] for more information.
  
 
'''Required PHP Extensions'''
 
'''Required PHP Extensions'''
  
Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing.  Should any be reported as missing, you should recompile PHP with the missing extensions included.
+
Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing.  Should any be reported as missing, you should recompile PHP with the missing extensions included, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#required_php_extensions here]
  
 
'''Recommended PHP Extensions'''
 
'''Recommended PHP Extensions'''
  
Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance.
+
Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance. Detailed in our help guide [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#recommended_php_extensions here] we recommend recompiling PHP with the missing extensions listed.  
  
 
'''Required PHP Functions'''
 
'''Required PHP Functions'''
Line 47: Line 51:
 
'''Error Reporting'''
 
'''Error Reporting'''
  
Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.
+
Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.  
  
 
'''PHP Error Levels'''
 
'''PHP Error Levels'''
  
Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types.
+
Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types, as detail [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#display_errors here]
  
 
'''PHP Version'''
 
'''PHP Version'''
Line 59: Line 63:
 
'''Customising Default Paths'''
 
'''Customising Default Paths'''
  
Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised.
+
Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised. Please see  [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.  
  
 
'''Using Default Templates'''
 
'''Using Default Templates'''
  
Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade.
+
Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade. Please see  [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.  
  
 
'''Installed cURL Version'''
 
'''Installed cURL Version'''
  
Checks the installed curl version and alerts you if your version is known to have any vulnerabilities.
+
Checks the installed curl version and alerts you if your version is known to have any vulnerabilities. More information available [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#curl_tls_openssl_version_warnings here]
  
 
'''SSL Support in cURL'''
 
'''SSL Support in cURL'''
Line 79: Line 83:
 
'''PHP Session Support'''
 
'''PHP Session Support'''
  
Alerts you to any issues with the PHP Session configuration in your PHP environment.
+
Alerts you to any issues with the PHP Session configuration in your PHP environment, please see both [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] documentation and [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] for more information.  
  
 
'''Secure TLS Support in cURL'''
 
'''Secure TLS Support in cURL'''
  
 
Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.
 
Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.

Latest revision as of 12:29, 8 September 2019

The Health & Updates page provides an overview of the WHMCS installation and system environment status.

It will highlight any potential configuration or security related issues that may need your attention.

It also allows you to check if any updates are available for your currently installed WHMCS version, as well as providing quick and easy access to the Changelog and Release Notes for it.

The Checks

An overview of the checks performed and the purpose of each is provided below.

System Cron Tasks

Checks that the system cron has run to completion within the last 24 hours. If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc...) or that the cron is failing to complete successfully.

If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. Further helpful documentation regarding this check can be found here

For further assistance, please contact our support team.

Cron PHP Version Mismatch

Many server configurations utilize a separate php.ini file in the command line or cron engine than the web server uses. This can sometimes cause issues when different configurations are used in two places.

This warning identifies if automation tasks are being executed under different PHP versions to that being used to visit the admin area via a browser.

Please review this guide for step-by-step instructions to resolve this situation on a stock cPanel server.

Otherwise contact your server admin/hosting provider for assistance.

Insecure Permissions Check

Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.

Please see this help guide for more information.

Required PHP Extensions

Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing. Should any be reported as missing, you should recompile PHP with the missing extensions included, as detailed here

Recommended PHP Extensions

Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance. Detailed in our help guide here we recommend recompiling PHP with the missing extensions listed.

Required PHP Functions

Checks for any PHP functions that are required for WHMCS to operate and will alert you to any that are disabled. If you see any functions reported here, you should check for the presence of them in the php.ini configuration file disable_functions setting and remove them.

PHP Memory Limit

Checks the memory limit setting in your PHP environment and will alert you when it is too low. Will alert you by way of a failure level alert when below the minimum required value and a warning level alert when above the minimum but below the recommended value. For more details on the required memory limit, please refer to the System Requirements page.

Error Reporting

Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.

PHP Error Levels

Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types, as detail here

PHP Version

Checks your PHP Version. Will alert you if your current PHP version has reached End of Life and is no longer supported by the PHP Group.

Customising Default Paths

Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised. Please see this helpful documentation about this.

Using Default Templates

Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade. Please see this helpful documentation about this.

Installed cURL Version

Checks the installed curl version and alerts you if your version is known to have any vulnerabilities. More information available here

SSL Support in cURL

Checks to ensure that the curl library present in the PHP environment has SSL support which is required for normal WHMCS operation and many of the modules which come with WHMCS.

Database Collations

Checks if all database tables and columns use utf8_unicode_ci collation. This is recommended to ensure correct searching and sorting for all international characters.

PHP Session Support

Alerts you to any issues with the PHP Session configuration in your PHP environment, please see both this documentation and this for more information.

Secure TLS Support in cURL

Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.