Difference between revisions of "Crons"

From WHMCS Documentation

m (Matt moved page Cron Jobs to Cron Tasks)
(Secure The Crons Directory)
Line 14: Line 14:
 
<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>
 
<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>
  
More information on moving the crons folder can be found in the Custom Crons Directory Article.
+
More information on moving the crons folder can be found in the [[Custom Crons Directory|Custom Crons Directory article]].
  
 
==Legacy Cron File Locations==
 
==Legacy Cron File Locations==

Revision as of 13:59, 11 June 2015

All files that WHMCS requires to be run on a periodic basis are located in the crons directory. A cron is simply the name given to a system daemon used to execute desired tasks (in the background) at designated times.

At the time of writing, WHMCS has 4 such files.

  • /crons/cron.php - The System Cron
  • /crons/domainsync.php - The Domain Expiry Synchronisation Cron
  • /crons/pipe.php - The Email Piping Forwarding Script
  • /crons/pop.php - The Email Piping POP Cron

Secure The Crons Directory

The crons folder may be moved to any place above or below the docroot.

We recommend moving it to a non-public directory above your web root to prevent web based access.

More information on moving the crons folder can be found in the Custom Crons Directory article.

Legacy Cron File Locations

Prior to WHMCS Version 6, the automated task files were located accross various directories.

To aide in the transition process to their new locations, Version 6.0 of WHMCS includes proxy files in the old locations that will allow all existing configured cron and piping commands to continue operating without any changes post upgrade to 6.0.

However, we encourage you to update your cron and piping commands to use the new locations at your earliest convenience.

The old locations are deprecated as of Version 6.0, and the proxy functionality will be removed in a future release. The proxy files and their proxy locations are:

  • /admin/cron.php
  • /pipe/pipe.php
  • /pipe/pop.php
If you do not require these proxy files, you can safely remove them from your installation.

Setting Up the Cron Tasks

Guidance on how to setup the cron tasks or email piping command can be found in their respective documentation pages: