cronjob.ini [CrontabSettings] #

The block [CrontabSettings] of settings/cronjob.ini, with 5 setting(s).

Never edit settings/cronjob.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/cronjob.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/cronjob.ini.append.php for one siteaccess,
• extension/<extension>/settings/cronjob.ini.append.php in an extension (read when the extension is active).

Install #

The cron job of the installation: the setup wizard, the kickstarter and exp:install write the
crontab lines that run the parts below, in the crontab of the system user that owns the
installation directory (never root's crontab), between the marker lines
"# BEGIN Exponential cronjobs: <root>" and "# END Exponential cronjobs: <root>".
bin/php/installcrontab.php --show, --add, --remove does the same on an installation that
exists (--add and --remove show what would change; with --apply they write). Without a crontab (a container, no crontab command, another user)
the installer prints the lines to add and carries on.
Guide: doc/eng-us/bc/6.0/installer-crontab.md

disabled: the installers write nothing and print the lines instead (for one exp:install run:
--no-crontab, or the environment variable EXP_INSTALL_CRONTAB=0).

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[CrontabSettings]
Install=enabled
*/ ?>

Parts #

The parts the cron job runs, each only when the installation defines it with at least one
script (an extension's part when the extension is active). An extension can add its own in its
settings/cronjob.ini.append.php. The schedule is [AdminSettings] CrontabSchedule_<part>.

Default: a list of 6: global, frequent, infrequent, expqueue, sqliimport, expai.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[CrontabSettings]
# an empty "Parts[]" first replaces the shipped list; without it the items are added
Parts[]
Parts[]=global
Parts[]=frequent
Parts[]=infrequent
Parts[]=expqueue
Parts[]=sqliimport
Parts[]=expai
*/ ?>

AdminParts #

The parts that run with the admin siteaccess (-s <admin>): their extensions are active there
only, or their jobs need the administration's settings. The others run with the default siteaccess.

Default: a list of 3: expqueue, sqliimport, expai.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[CrontabSettings]
# an empty "AdminParts[]" first replaces the shipped list; without it the items are added
AdminParts[]
AdminParts[]=expqueue
AdminParts[]=sqliimport
AdminParts[]=expai
*/ ?>

AdminSiteAccess #

The admin siteaccess of AdminParts[] (set it in settings/override). Empty: admin when it exists,
else the first siteaccess of AvailableSiteAccessList[] with "admin" in its name.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[CrontabSettings]
AdminSiteAccess=
*/ ?>

CrontabCommand #

The crontab command: a name on the PATH or a full path.

Default: crontab.

<?php /* #?ini charset="utf-8"?
# settings/override/cronjob.ini.append.php
[CrontabSettings]
CrontabCommand=crontab
*/ ?>

Related #

• All blocks of cronjob.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/cronjob.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.