Cron Configuration

From WHMCS Documentation

Revision as of 10:50, 9 December 2016 by John (talk | contribs) (cPanel)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Cron tasks must be created to automate tasks within WHMCS.

Cron is the name given to a system daemon used to execute tasks (in the background) at designated times. WHMCS has a number of files that are required to be run on a periodic basis in this way. All these files are located in the crons directory.

A single cron named the System Cron automates all core functions of the system including invoicing, reminders, suspensions and other daily automation tasks.

In WHMCS 6.3.x and earlier, the system cron should be configured to run no more than once per day. In WHMCS 7.0 and later, the system cron should be configured to run every 5 minutes, or as frequently as your web hosting provider will allow.

Setting Up Cron Jobs

The tutorials & screenshots below demonstrate how to configure the WHMCS cron on the most common hosting control panels.

You can obtain the exact cron command you should use for your installation from Setup > Automation Settings at any time.

The examples below will setup the cron to run at 9am every day.

cPanel

Watch Video Tutorial


Click on the Cron Job icon in cPanel, select the Once A Day option from the Common Settings dropdown menu. Then paste the cron command into the Command field.

Cpstandard.jpg

Alternatively click the Advanced (Unix Style) button and use the following:

cPanel Cron
Option Minute Hour Day Month Weekday Command
a) */5 * * * * php -q /path/to/home/public_html/whmcspath/crons/cron.php
b) */5 * * * * wget -O http://www.yourdomain.com/whmcspath/crons/cron.php >/dev/null
c) */5 * * * * GET http://www.yourdomain.com/whmcspath/crons/cron.php

Direct Admin

The command for Direct Admin is generally the same as cPanel, however, you need to reference the full path to the php binary.

This can be /usr/bin/php, /usr/bin/home/php or /usr/local/bin/php but this is dependent on the server setup and you should check with your Server Administrator for the full path to the php binary.

An example command to run is:

Command
/usr/bin/php -q /home/demo_user/domains/testdomain.com/public_html/whmcspath/crons/cron.php
/usr/local/bin/php -q /home/demo_user/domains/testdomain.com/public_html/whmcspath/crons/cron.php
wget -O /dev/null http://domain.tld/path/to/cron.php
GET http://www.yourdomain.com/whmcspath/crons/cron.php

Da crons.jpg

DotNetPanel

Navigate to the hosting space in which WHMCS is installed and click Scheduled Tasks from the Hosting Space Menu, then click Add Scheduled Task.

From the Task Type dropdown menu select the Check Web Site Availability option and enter the URL of the cron.php file into the URL field. Use the Schedule options to run this task Daily and finally ensure it's active and running.

Wsp cron config.png

Windows Server

Depending on your server setup, you can run the cron directly from the php executable. If this is not possible, you would need to use the server browser to run the cron

An example command to run is:

Command
C:\php\php.exe -q "C:\inetpub\wwwroot\whmcs7\admin\cron.php"
"c:\program files\internet explorer\iexplore.php" "http://www.yourdomain.com/whmcspath/cron.php"

You should then set the task to run at a certain time every day. The time is up to you.

Windows cron.jpg

Plesk

You can specify the php command using the following on Linux Plesk:

env php -q /home/user/whmcs/crons/cron.php

Pleskcron.jpg

The Windows version of Plesk is slightly different. You need to specify the path to the php executable and then specify the path to your cron.php file.

Check the appropriate boxes to run at the time you wish and press ok to save.

Plesksts.jpg

Helm

Helm3cron.jpg

InterWorx

Interworx.jpg