Difference between revisions of "System Utilities"

From WHMCS Documentation

(PHP Info)
Line 54: Line 54:
 
==PHP Info==
 
==PHP Info==
  
The '''PHP Info''' page outputs a variety of information about the current configuration of PHP and the server. This includes information such as PHP options and extensions, the PHP version, server information, and <tt>php.ini</tt> configuration settings currently in use for the WHMCS Admin Area.
+
WHMCS can display a variety of information about the current configuration of PHP and the server.  
  
These details come directly from the <tt>phpinfo()</tt> PHP function and are not edited or changed by WHMCS.
+
For more information, see [[PHP Info]].
  
 
==Troubleshooting System Utilities==
 
==Troubleshooting System Utilities==

Revision as of 21:45, 17 January 2022

WHMCS includes many utilities to help you manage your system.

Link Tracking

The link or ad tracker tool allows you to track your advertising campaigns. You can set up the various links you want to use and then, instead of linking directly, you use the tracking link WHMCS gives you. It then tracks the number of clickthroughs you get and, ultimately, conversions, using a cookie and providing an easy way to analyse how successful different promotions and links are.

For more information, see Link Tracking.

Calendar

The Calendar

The calendar lists all pending, active and suspended products, addons, domains, and to-do items on the dates they are due.

For more information, see Calendar.

To-Do List

The to-do list allows you to add tasks that need to be finished, the dates they are due for completion, and the assigned admin.

For more information, see To-Do List.

Activity Logs

WHMCS logs all activity, admin logins, gateway communications, sent and received email communications, and domain lookups. This allows you to monitor and track all the activity taking place inside your WHMCS system. You can find the logs in the left-side menu at Configuration () > System Logs or in the Utilities menu in WHMCS 7.x and earlier. They include:

  • Activity Log
  • Admin Log
  • Module Log
  • Email Message Log
  • Ticket Mail Import Log
  • WHOIS Lookup History Log

Note: The Email Message Log will log all emails that WHMCS sends to clients, with the exception of the "Automated Password Reset", "Client Email Address Verification", and "Password Reset Validation" emails.

Over time, log records in your WHMCS System will accumulate. As the number of records grows, so will your database, and you may begin noticing a reduction in performance. If these start affecting performance, WHMCS allows you to empty them at any time. To empty your logs, perform the following actions:

  1. Log in to your WHMCS Admin Area.
  2. Navigate to Utilities > System Cleanup. You will see options to empty the Gateway, and WHOIS Lookup logs.
  3. Click the Go button next to the log you would like to empty. A confirmation message will then appear, confirming that the system emptied the log.

Additionally, from the same Cleanup Operations page, you can prune the Client Activity Logs so that the system only maintains entries after a specified date. To do this, enter in your desired date, and click on the Delete button. Again, a confirmation message will then appear to confirm that the system pruned the log.

Database Backups

WHMCS stores its data in your database, so is very important. It is therefore recommended that you take regular backups of it. There are two built-in solutions for automated database backups using the daily cron. One is email and the other is an FTP backup to a remote server. You can find configuration instructions on the Backups Page.

System Cleanup

With constant daily operations, the log files in WHMCS can become very large. Because of this, WHMCS allows you to prune logs to reduce the size of the database and reduce disk space.

For more information, see System Cleanup.

PHP Info

WHMCS can display a variety of information about the current configuration of PHP and the server.

For more information, see PHP Info.

Troubleshooting System Utilities

Database Backup Fails/Timesout

The most common reason for database backups to fail is simply that it has grown too large and the PHP process takes too long or uses too much memory and is killed before it can complete the backup process.

You can find further details on this in the Backups Limitations section.