Marcel de Rooy
5588d688fd
Note: I did not add an example to the debian cron daily file, since we have no commented lines there. And automatic renewal is no default behavior. Test plan: Read new lines in misc/cronjobs/crontab.example. Just comments. Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: Lucas Gass <lucas@bywatersolutions.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
101 lines
4.6 KiB
Text
101 lines
4.6 KiB
Text
# Koha Example Crontab File
|
|
# Author: Joe Atzberger <atz@liblime.com>
|
|
#
|
|
# This is an example of a crontab file for Debian. It may not work
|
|
# in other versions of crontab, like on Solaris 8 or BSD, for example.
|
|
#
|
|
# While similar in structure,
|
|
# this is NOT an example for cron (as root). Cron takes an extra
|
|
# argument per line to designate the user to run as. You could
|
|
# reasonably extrapolate the needed info from here though.
|
|
#
|
|
# WARNING: These jobs will do things like charge fines, send
|
|
# potentially VERY MANY emails to patrons and even debar offending
|
|
# users. DO NOT RUN OR SCHEDULE these jobs without being sure you
|
|
# really intend to. Make sure the relevant message templates are
|
|
# configured to your liking before scheduling messages to be sent.
|
|
#
|
|
# ENVIRONMENT:
|
|
# First, establish Koha's two important ENV variables.
|
|
|
|
PERL5LIB=/usr/share/koha/lib
|
|
KOHA_CONF=/etc/koha/koha-conf.xml
|
|
|
|
# Some additional variables to save you typing
|
|
KOHA_CRON_PATH = /usr/share/koha/bin/cronjobs
|
|
#
|
|
# MULTIPLE KOHA SUPPORT:
|
|
# You can still run jobs for this user's additional koha installs,
|
|
# by manipulating those variables in the command.
|
|
#
|
|
# For example, on the same codebase:
|
|
# */10 * * * * __KOHA_USER__ KOHA_CONF=/etc/koha/koha-conf.xml /usr/share/koha/bin/migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
|
|
#
|
|
# For example, on a separate codebase:
|
|
# */10 * * * * __KOHA_USER__ KOHA_CONF=/etc/koha/koha-conf.xml PERL5LIB=/home/koha/kohaclone /home/koha/kohaclone/misc/migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
|
|
#
|
|
# ADDITIONAL INFO:
|
|
# See the perldoc of individual scripts to determine what other options
|
|
# are available. Check the man page for crontab to understand the
|
|
# schedule syntax for your system.
|
|
#
|
|
# NOTE: Don't forget to keep the empty line at the bottom.
|
|
# Cron/crontab will choke without it.
|
|
#
|
|
# SCHEDULED JOBS:
|
|
# m h dom mon dow user command
|
|
|
|
# RECALLS + AUTOMATIC RENEWAL + AUTOMATIC CHECK-IN + FINES + OVERDUE NOTICES
|
|
# Sequence is important - renew what can be renewed, check things in if set to, charge fines for the rest, print fine amount into overdue notices
|
|
# Handle expired recalls and overdue recalls before fines.pl runs
|
|
5 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/recalls/expire_recalls.pl; $KOHA_CRON_PATH/recalls/overdue_recalls.pl; $KOHA_CRON_PATH/automatic_renewals.pl -c; $KOHA_CRON_PATH/automatic_checkin.pl ; $KOHA_CRON_PATH/fines.pl; $KOHA_CRON_PATH/overdue_notices.pl -t
|
|
|
|
# ADVANCE NOTICES
|
|
10 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/advance_notices.pl -c
|
|
|
|
# MEMBERSHIP_EXPIRY NOTICES
|
|
15 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/membership_expiry.pl -c
|
|
# To allow automatic renewal for 'active' patrons and send expiry notices to inactive ones, do:
|
|
# 15 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/membership_expiry.pl -c -active -renew
|
|
# 15 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/membership_expiry.pl -c -inactive
|
|
|
|
# SERIALS UPDATE
|
|
18 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/serialsUpdate.pl -c
|
|
|
|
# PROCESS LONG OVERDUES
|
|
# updates item status from available to longoverdue for items long overdue
|
|
# 19 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/longoverdue.pl --lost 90=1 --confirm
|
|
|
|
# SEND EMAILS
|
|
15 * * * * __KOHA_USER__ $KOHA_CRON_PATH/process_message_queue.pl
|
|
|
|
# Hourly holds queue updated
|
|
52 * * * * __KOHA_USER__ $KOHA_CRON_PATH/holds/build_holds_queue.pl >/dev/null 2>&1
|
|
|
|
# Cancel expired holds
|
|
0 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/holds/cancel_expired_holds.pl >/dev/null 2>&1
|
|
|
|
# Auto unsuspend holds
|
|
0 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/holds/auto_unsuspend_holds.pl > /dev/null 2>&1
|
|
|
|
# Update popularity counts for biblio records
|
|
0 2 * * * __KOHA_USER__ $KOHA_CRON_PATH/update_totalissues.pl --commit=1000 --use-stats --incremental --interval=1d >/dev/null 2>&1
|
|
|
|
# ZEBRA INDEX UPDATES with -z option, incremental index updates throughout the day
|
|
# for both authorities and bibs
|
|
*/10 * * * * __KOHA_USER__ $KOHA_CRON_PATH/../migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
|
|
|
|
# clean up databases nightly. Be sure not to run this with --sessions during a time when the system is in use!
|
|
16 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/cleanup_database.pl --confirm --sessions --zebraqueue 10 --list-invites --temp-uploads --del-unv-selfreg 14
|
|
|
|
# delete old purchase suggestions weekly. Replace XX with a number to define the age of suggestions to delete.
|
|
@weekly __KOHA_USER__ $KOHA_CRON_PATH/purge_suggestions.pl --confirm --days XX > /dev/null 2>&1
|
|
|
|
# share_usage_with_koha_community.pl every months
|
|
0 0 1 * * __KOHA_USER__ $KOHA_CRON_PATH/share_usage_with_koha_community.pl
|
|
|
|
# run merge authorities
|
|
20 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/merge_authorities.pl -b
|
|
|
|
# PLUGIN JOBS
|
|
10 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/plugins_nightly.pl
|