Difference between revisions of "System Cleanup"
(Created page with "Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space. You can use this tool at ''...") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space. | Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space. | ||
| − | You can | + | You can access this feature at '''Utilities > System > System Cleanup'''. |
<div class="docs-alert-warning"> | <div class="docs-alert-warning"> | ||
| − | + | Only delete information that you're certain is not necessary. WHMCS Technical Support '''cannot''' assist with some cases if you have removed the relevant log files. | |
| − | Only delete information you're certain is not necessary. WHMCS Technical Support '''cannot''' assist with some cases if you have removed the relevant | ||
</div> | </div> | ||
| Line 20: | Line 19: | ||
====Empty Gateway Log==== | ====Empty Gateway Log==== | ||
| − | + | Deletes the contents of the '''Billing > [[Gateway Log]]''' (communication between you and your payment gateways). It does not affect transactions and invoices. | |
====Empty Whois Lookup Log==== | ====Empty Whois Lookup Log==== | ||
| − | + | Deletes the contents of the '''WHOIS Lookup Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' of the domains that clients have checked. | |
====Empty Ticket Mail Import Log==== | ====Empty Ticket Mail Import Log==== | ||
| − | + | Deletes the contents of the '''Ticket Mail Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''. This removes the record of emails you piped into the WHMCS ticket system but does not affect the tickets themselves. | |
====Empty Template Cache==== | ====Empty Template Cache==== | ||
| Line 44: | Line 43: | ||
====Prune Client Activity Logs==== | ====Prune Client Activity Logs==== | ||
| − | Select a date to remove any client entries in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' | + | Select a date before which to remove any client entries in the '''Activity Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''. Non-client-related entries will remain. |
====Prune Saved Emails==== | ====Prune Saved Emails==== | ||
| − | Select a date to remove any | + | Select a date to remove any e-mails from before that date. |
==== Prune Old Attachments==== | ==== Prune Old Attachments==== | ||
| Line 55: | Line 54: | ||
==System Cleanup page fails to load== | ==System Cleanup page fails to load== | ||
| − | |||
| − | + | If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable <tt>attachments</tt> directory. | |
| − | + | At '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Storage Settings]]''' or, prior to WHMCS 8.0, '''Setup > Storage Settings''', make certain that the attachments directory path exists, is readable, and is absolute. | |
| + | |||
| + | For more information, see [[Moving Storage Locations]]. | ||
Latest revision as of 18:47, 9 May 2022
Over time, the log files in WHMCS can become very large. WHMCS allows you to prune logs to reduce the size of the database and reduce disk space.
You can access this feature at Utilities > System > System Cleanup.
Only delete information that you're certain is not necessary. WHMCS Technical Support cannot assist with some cases if you have removed the relevant log files.
Contents
Cleanup Operations
You can remove data using the following options:
Simple
For each option in the Simple tab, click Go to empty that log or cache.
The system will immediately remove the data and you will see a Cleanup Command Successful success message.
Empty Gateway Log
Deletes the contents of the Billing > Gateway Log (communication between you and your payment gateways). It does not affect transactions and invoices.
Empty Whois Lookup Log
Deletes the contents of the WHOIS Lookup Log at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs of the domains that clients have checked.
Empty Ticket Mail Import Log
Deletes the contents of the Ticket Mail Import Log at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs. This removes the record of emails you piped into the WHMCS ticket system but does not affect the tickets themselves.
Empty Template Cache
WHMCS caches templates into static files to reduce the loading time of each page. In order for template changes to take effect, it is necessary to clear the cached files using this tool. This removes all existing files from the templates_c folder.
Make sure the /templates_c directory is writeable so that WHMCS is able to delete the cache files and generate new ones.
Advanced
For each option in the Advanced tab, select a date and click Delete. The system will delete log entries, emails, or attachments from before that date.
The system will immediately remove the data and you will see a Cleanup Command Successful success message.
Prune Client Activity Logs
Select a date before which to remove any client entries in the Activity Log at Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Logs. Non-client-related entries will remain.
Prune Saved Emails
Select a date to remove any e-mails from before that date.
Prune Old Attachments
Select a date to remove any support ticket attachments from closed tickets which are also older than the date selected. The system will also delete them from the /attachments directory.
System Cleanup page fails to load
If the System Cleanup page fails to load entirely, this can be caused by a missing or unreadable attachments directory.
At Configuration () > System Settings > Storage Settings or, prior to WHMCS 8.0, Setup > Storage Settings, make certain that the attachments directory path exists, is readable, and is absolute.
For more information, see Moving Storage Locations.