Created database-tidying cron script
[koha.git] / misc / cronjobs / crontab.example
index 33b5d28..bdb58f7 100644 (file)
@@ -2,12 +2,12 @@
 # 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, for example.
+# in other versions of crontab, like on Solaris 8 or BSD, for example.
 # 
-# While similar in strcture, 
+# 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 extrapoloate the needed info from here though.
+# 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
 PERL5LIB=/home/liblime/kohaclone
 KOHA_CONF=/home/liblime/kohaclone/etc/koha-conf.xml
 
+# Some additional variables to save you typing
+KOHA_CRON_PATH = /home/liblime/kohaclone/misc/cronjobs
 #
 # MULTIPLE KOHA SUPPORT:
-# You can still run jobs for this user's additional koha installs.
+# 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_CONF=/home/liblime/koha-test/etc/koha-conf.xml /home/liblime/kohaclone/misc/migration_tools/rebuild_zebra.pl -b -z >/dev/null
+# */10 * * * *    KOHA_CONF=/home/liblime/koha-test/etc/koha-conf.xml /home/liblime/kohaclone/misc/migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
 #
 # For example, on a separate codebase:
-# */10 * * * *    KOHA_CONF=/home/liblime/koha-test/etc/koha-conf.xml PERL5LIB=/home/liblime/koha-test /home/liblime/koha-test/misc/migration_tools/rebuild_zebra.pl -b -z >/dev/null
+# */10 * * * *    KOHA_CONF=/home/liblime/koha-test/etc/koha-conf.xml PERL5LIB=/home/liblime/koha-test /home/liblime/koha-test/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.  
 #
-# SCHEDULED JOBS:
-# Don't forget to keep the empty line at the bottom. 
+# 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   command
-0  1 * * *  /home/liblime/kohaclone/misc/cronjobs/overdue_notices.pl
-5  1 * * *  /home/liblime/kohaclone/misc/cronjobs/fines-ll.pl
-10 1 * * *  /home/liblime/kohaclone/misc/cronjobs/advance_notices.pl -c
-15 * * * *  /home/liblime/kohaclone/misc/cronjobs/process_message_queue.pl
-*/10 * * * *   /home/liblime/kohaclone/misc/migration_tools/rebuild_zebra.pl -b -z >/dev/null
 
+# OVERDUE NOTICES
+0    1 * * *  $KOHA_CRON_PATH/overdue_notices.pl -t
+
+# FINES
+5    1 * * *  $KOHA_CRON_PATH/fines.pl
+
+# ADVANCE NOTICES
+10   1 * * *  $KOHA_CRON_PATH/advance_notices.pl -c
+
+# PROCESS LONG OVERDUES
+# updates item status from available to longoverdue for items long overdue
+# 19 1 * * *  $KOHA_CRON_PATH/longoverdue.pl --lost 90=1 --confirm
+
+# SEND EMAILS
+15   * * * *  $KOHA_CRON_PATH/process_message_queue.pl
+
+# Hourly holds queue updated
+52   * * * *  $KOHA_CRON_PATH/holds/build_holds_queue.pl >/dev/null 2>&1
+
+# ZEBRA INDEX UPDATES with -z option, incremental index updates throughout the day
+# for both authorities and bibs
+*/10 * * * *  $KOHA_CRON_PATH/../migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
+
+# services_throttle -- resets the xISBN service
+59 23 * * *  $KOHA_CRON_PATH/services_throttle.pl > /dev/null 2>&1
+
+# ROTATE LOGS
+# Obviously, one needs logrotate(8) to do this
+# 20 1 * * *  /usr/sbin/logrotate -s /home/liblime/kohaclone/var/run/zebradb/logstatus /home/liblime/kohaclone/etc/logrotate.conf
+
+# clean up databases nightly.  Be sure not to run this with --sessions during a time when the system is in use!
+16 1 * * * $KOHA_CRON_PATH/cleanup_database.pl --sessions --zebraqueue 10