xF2 Add-on CLI Job Runner 1.5.0

This XenForo 2.x addon disables the browser triggered job runner and implements a CLI triggered job runner for use with Unix cron.

Requirements

This addon requires PHP 5.4 or higher and has been tested on XenForo 2.0.x and 2.1.x

Installation

Install as per normal addon installation.

Note: once this addon is installed and activated, scheduled tasks will no longer run - so completing the remaining installation steps is critical to ensure your forum continues to function normally.

First, you should test that your job runner is functioning - execute the following command from your CLI:
For example, if your forum root is /srv/www/xenforo/community, then the job runner command would be:
Running this command will execute any outstanding jobs and then finish with a message about whether there are more jobs waiting to be executed or not. When executing this command from cron, it is recommended that you use the --quiet (or -q) flag to suppress output.

Once you are happy that the job runner functions correctly, you will need to create your own cron task to run it on a schedule of your choosing.

Approach #1 using crontab:

It is highly recommended that you have your cron task run as the web server user to prevent potential permission problems.

For example, on Ubuntu with a web server user of www-data, install a cron task by running the following command:
Edit the crontab file and add:
Save the crontab.

Approach #2 using cron.d:

Instead of using a crontab, some Linux distributions create a well-known directory which is automatically checked for cron tasks to execute. In the case of Ubuntu, you can create files in /etc/cron.d/ where you specify the schedule, the user to execute the command as, and the command itself.

Create a file in /etc/cron.d/ with the following contents:
... where webserver-user is changed to the name of the user your web server runs as and change the path to your forum root.

Again, using our previous example where web server user is www-data and our forum root is
/srv/www/xenforo/community, I would execute the following command to create the cron file:
Both options (crontab and cron.d) will execute the job runner every minute, checking for outstanding jobs to be run.

By default, the job runner will run for a maximum of 30 seconds, executing any outstanding jobs until there are no more runnable jobs in the queue.

Configuration

You may adjust the maximum execution time of the job runner by specifying the --time=[TIME] option on the command line.


For example, to allow the job runner to execute for a maximum of 45 seconds:

It is not recommended that you allow the job runner to run for longer than the period between cron triggers. For example, the above cron task example will execute the job runner every minute, so setting the maximum run time to more than 60 is generally a bad idea.

If you prefer to not run the cron task as frequently as once per minute, you can adjust the cron job as
required and if you do, you may also want to allow the job runner task to run for longer than the default 30 seconds to ensure that all outstanding work is completed.

For example, to run the cron task every 5 minutes, allowing the job runner to execute for a maximum of 4 minutes, use the following cron command:
For further customisation of your job execution, you may also adjust the maximum time that each job is permitted to run.
This is configured via a XenForo config.php Option:
The jobMaxRunTime option configures the amount of time in seconds that processing jobs will be allowed to run before they are suspended for further processing on another go-around, if possible. The default setting is optimised for the browser-triggered job runner and so to allow jobs to execute longer in a CLI environment, you may want to adjust this to a higher value.

You should not set jobMaxRunTime to anything higher than 30 seconds, or the time specified by the --time option. In general it is suggested that this setting be kept to a relatively small value to avoid the situation where a single very long job may prevent other jobs from executing in a timely manner. Some experimentation may be required to find the optimal value for your server load and forum size.

Usage

The run-jobs command should be executed automatically using a cron task as per the instructions above.

Show Jobs

The xf:show-jobs command outputs a list of all the currently pending jobs, so you can see how full the jobs queue is.

By default only the next scheduled 100 jobs will be shown, you may use the --all option to show a complete list of all pending jobs.

There should always be at least one job (the main Cron job) in the list. For XF 2.1 you will also see the upgrade check job.