Skip to the content
Documentation

[CrontabSettings]

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The group [CrontabSettings] of settings/cronjob.ini.

File

settings/cronjob.ini; override it in settings/override/cronjob.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
Install enabled 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).
Parts[] global; frequent; infrequent; expqueue; sqliimport; expai 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>.
AdminParts[] expqueue; sqliimport; expai 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.
AdminSiteAccess (empty) 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.
CrontabCommand crontab The crontab command: a name on the PATH or a full path.

See also

Generated example: cronjob.ini [CrontabSettings]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/cronjob.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.