Skip to content

Latest commit

 

History

History
154 lines (119 loc) · 5.34 KB

README.md

File metadata and controls

154 lines (119 loc) · 5.34 KB
Raw

systemd-cron

systemd units to run cron scripts

Description

systemd units to provide cron daemon functionality by running scripts in cron directories.
The crontabs are automaticaly translated using /usr/lib/systemd/system-generators/systemd-crontab-generator.

Usage

Add executable scripts to the appropriate cron directory (e.g. /etc/cron.daily) and enable systemd-cron:

# systemctl daemon-reload
# systemctl enable cron.target
# systemctl start cron.target

The project also includes simple crontab command equivalent, which behaves like standard crontab command (and accepts the same main options).

The scripts should now be automatically run by systemd. See man:systemd.cron(7) for more information.

Dependencies

  • systemd ≥ 236
  • python ≥ 3.9
  • run-parts (optional)
  • /usr/sbin/sendmail (optional, evaluated at runtime)
  • gcc or clang (needed to build crontab_setgid.c; this helper is optional and evaluated at runtime)
  • support for /usr/lib/sysusers.d/*.conf (optional)

Dependencies history

  • systemd ≥ 197, first support for timers
  • systemd ≥ 209, yearly timers
  • systemd ≥ 212, persistent timers
  • systemd ≥ 217, minutely, quarterly & semi-annually timers
  • systemd ≥ 229, real random delay support with RandomizedDelaySec option
  • systemd ≥ 236, LogLevelMax option

Installation

There exists packages avaible for:

There is also a .spec file for Fedora in contrib/.

You can also build it manually from source.

Packaging

Building

$ ./configure
$ make

Staging

$ make DESTDIR="$destdir" install

Configuration

The configure script takes command line arguments to configure various details of the build. The following options follow the standard GNU installation directories:

  • --prefix=<path>
  • --bindir=<path>
  • --confdir=<path>
  • --datadir=<path>
  • --libdir=<path>
  • --statedir=<path>
  • --mandir=<path>
  • --docdir=<path>

Other options include:

  • --unitdir=<path> Path to systemd unit files. Default: <libdir>/systemd/system.
  • --runparts=<path> The path installations should use for the run-parts executable. Default: <prefix>/bin/run-parts.
  • --enable-boot[=yes|no] Include support for the boot timer. Default: yes.
  • --enable-minutely[=yes|no] Include support for the minutely timer. Requires systemd ≥ 217. Default: no.
  • --enable-hourly[=yes|no] Include support for the hourly timer. Default: yes.
  • --enable-daily[=yes|no] Include support for the daily timer. Default: yes.
  • --enable-weekly[=yes|no] Include support for the weekly timer. Default: yes.
  • --enable-monthly[=yes|no] Include support for the monthly timer. Default: yes.
  • --enable-quarterly[=yes|no] Include support for the quarterly timer. Requires systemd ≥ 217. Default: no.
  • --enable-semi_annually[=yes|no] Include support for the semi-annually timer. Requires systemd ≥ 217. Default: no.
  • --enable-yearly[=yes|no] Include support for the yearly timer. Requires systemd ≥ 209. Default: no.
  • --enable-persistent[=yes|no] Make timers persistent. Requires systemd ≥ 212. Default: no.
  • --enable-randomized-delay=[yes|no] Use [RandomizedDelaySec] option for RANDOM_DELAY support. Requires systemd ≥ 229. Default: yes.
  • --enable-setgid[=yes|no] Compile setgid C helper for crontab. Needs GCC or Clang. Default: no.

A typical configuration for the latest systemd would be:

$ ./configure --prefix=/usr --confdir=/etc --enable-yearly --enable-persistent

If you only want the generator (you'll have to provide your own /etc/crontab to drive /etc/cron.daily/ etc...):

$ ./configure --enable-boot=no --enable-hourly=no --enable-daily=no --enable-weekly=no --enable-month=no --enable-persistent --prefix=/usr --confdir=/etc

Caveat

Your package should also run these extra commands before starting cron.target to ensure that @reboot scripts doesn't trigger right away:

# touch /run/crond.reboot
# touch /run/crond.bootdir

See Also

systemd.cron(7) or in source tree man -l src/man/systemd.cron.7

License

The project is licensed under MIT.

Copyright

© 2014, Dwayne Bent : original package with static units
© 2014, Konstantin Stepanov ([email protected]) : author of crontab generator
© 2014, Daniel Schaal : review of crontab generator
© 2014, Alexandre Detiste ([email protected]) : manpage for crontab generator