Revision as of 17:36, 2 January 2012

The WHMCS cron job is the process that performs all the automated actions.

Just 1 single cron job needs to be setup to automate all the core functions of the system (invoicing, reminders, suspensions, etc...)

The cron must be configured to run no more than once per day.

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 need to 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

We have prepared a video tutorial for this section: http://whmcs.com/tutorials.php?i=1

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.

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

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:

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.

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:

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

Plesk

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

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

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.

Helm

InterWorx

Option Flags

Passing in option flags to the cron process allows you to customise the actions that get performed. By default, all actions will run but you can pass in any of the flags below to skip certain processes.

• skip_invoices
• skip_latefees
• skip_ccprocessing
• skip_invoicereminders
• skip_domainrenewalnotices
• skip_suspensions
• skip_terminations
• skip_cancelrequests
• skip_closetickets
• skip_affreports
• skip_ccexpirynotices
• skip_usagestats
• skip_backups

Flags are passed in by simply appending them to the cron command, for example to not run CC processing you could use "php -q /home/username/public_html/admin/cron.php skip_ccprocessing" or alternatively as a browser request, like this "get http://www.yourdomain.com/admin/cron.php?skip_ccprocessing=1"

To skip multiple items the following format can be used "php -q /home/username/public_html/admin/cron.php skip_ccprocessing skip_usagestats" or alternatively "get http://www.yourdomain.com/admin/cron.php?skip_ccprocessing=1&skip_usagestats=1"