Difference between revisions of "Cron Configuration"
(→How to use Option Flags) |
|||
| Line 176: | Line 176: | ||
Option flags should be specified after the cron path. For example, to skip credit card processing, you would configure the cron command as follows: | Option flags should be specified after the cron path. For example, to skip credit card processing, you would configure the cron command as follows: | ||
| − | < | + | <div class="source-cli"><nowiki> |
php -q /path/to/cron.php skip_ccprocessing | php -q /path/to/cron.php skip_ccprocessing | ||
| − | </ | + | </nowiki></div> |
To perform automatic ticket closure and usage status updating, you would configure the cron command as follows: | To perform automatic ticket closure and usage status updating, you would configure the cron command as follows: | ||
| − | < | + | <div class="source-cli"><nowiki> |
php -q /path/to/cron.php do_closetickets do_usagestats | php -q /path/to/cron.php do_closetickets do_usagestats | ||
| − | </ | + | </nowiki></div> |
Or alternatively as a browser request, like this: | Or alternatively as a browser request, like this: | ||
| − | < | + | <div class="source-cli"><nowiki> |
GET http://www.yourdomain.com/crons/cron.php?do_closetickets=1&do_usagestats=1 | GET http://www.yourdomain.com/crons/cron.php?do_closetickets=1&do_usagestats=1 | ||
| − | </ | + | </nowiki></div> |
You can specify as many option flags in a single cron command as you require. | You can specify as many option flags in a single cron command as you require. | ||
Revision as of 12:07, 17 September 2016
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.
Contents
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
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:
| Option | Minute | Hour | Day | Month | Weekday | Command | ||
|---|---|---|---|---|---|---|---|---|
| a) | 0 | 9 | * | * | * | php -q /path/to/home/public_html/whmcspath/crons/cron.php | ||
| b) | 0 | 9 | * | * | * | wget -O http://www.yourdomain.com/whmcspath/crons/cron.php >/dev/null | ||
| c) | 0 | 9 | * | * | * | 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 |
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:
| 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.
Plesk
You can specify the php command using the following on Linux Plesk:
env php -q /home/user/whmcs/crons/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 or only do certain processes.
Flags
- affcommissions - Calculate affiliate commissions
- affreports - Send affiliate reports on the first day of the month only
- backups - Generate WHMCS database backup
- cancelrequests - Process cancellation requests
- ccexpirynotices - Send credit card expiration notices
- ccprocessing - Process credit card payments
- clientstatussync - Change client statuses (Active, Inactive, Closed)
- closetickets - Auto-close answered tickets
- domainrenewalnotices - Send upcoming domain renewal notice emails
- emailmarketing - Send email marketer emails
- escalations - Perform ticket escalation rules
- fixedtermterminations - Terminate fixed-term products due today
- invoicereminders - Send invoice payment reminder emails
- invoices - Generate due invoices
- latefees - Apply late fees to overdue invoices
- overagesbilling - Generate overage invoices on the last day of the month only
- suspensions - Suspend overdue accounts
- terminations - Terminate overdue accounts
- updatepricing - Update product prices based upon the currency base conversion rates
- updaterates - Update currency base conversion rates
- usagestats - Update usage statistics from the server
- skip_report - Do not send the WHMCS Cron Job Activity email
How to use Option Flags
Flags are passed in by simply appending them to the cron command. All the flags can be preceded with do_ or skip_. When running with do_, the cron will only complete the actions listed, everything else will be skipped. When using skip_, the cron will run all commands except those specified to be skipped.
Note:
Skipping or doing functions will not stop the cron job hooks from running. These will run any time the cron.php file is accessed, irrespective of the number of actions to be completed.
Option flags should be specified after the cron path. For example, to skip credit card processing, you would configure the cron command as follows:
To perform automatic ticket closure and usage status updating, you would configure the cron command as follows:
Or alternatively as a browser request, like this:
You can specify as many option flags in a single cron command as you require.