Bug 28571: Remove C4::Auth::_session_log
[koha.git] / misc / cronjobs / crontab.example
1 # Koha Example Crontab File
2 # Author: Joe Atzberger <atz@liblime.com>
3 #
4 # This is an example of a crontab file for Debian.  It may not work 
5 # in other versions of crontab, like on Solaris 8 or BSD, for example.
6
7 # While similar in structure, 
8 # this is NOT an example for cron (as root).  Cron takes an extra
9 # argument per line to designate the user to run as.  You could 
10 # reasonably extrapolate the needed info from here though.
11 #
12 # WARNING: These jobs will do things like charge fines, send
13 # potentially VERY MANY emails to patrons and even debar offending
14 # users.  DO NOT RUN OR SCHEDULE these jobs without being sure you
15 # really intend to.  Make sure the relevant message templates are
16 # configured to your liking before scheduling messages to be sent.
17 #
18 # ENVIRONMENT:
19 # First, establish Koha's two important ENV variables.
20
21 PERL5LIB=/usr/share/koha/lib
22 KOHA_CONF=/etc/koha/koha-conf.xml
23
24 # Some additional variables to save you typing
25 KOHA_CRON_PATH = /usr/share/koha/bin/cronjobs
26 #
27 # MULTIPLE KOHA SUPPORT:
28 # You can still run jobs for this user's additional koha installs, 
29 # by manipulating those variables in the command.
30 #
31 # For example, on the same codebase:
32 # */10 * * * *    __KOHA_USER__  KOHA_CONF=/etc/koha/koha-conf.xml /usr/share/koha/bin/migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
33 #
34 # For example, on a separate codebase:
35 # */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
36
37 # ADDITIONAL INFO:
38 # See the perldoc of individual scripts to determine what other options
39 # are available.  Check the man page for crontab to understand the 
40 # schedule syntax for your system.  
41 #
42 # NOTE: Don't forget to keep the empty line at the bottom. 
43 # Cron/crontab will choke without it.
44 #
45 # SCHEDULED JOBS:
46 # m h  dom mon dow   user command
47
48
49 # AUTOMATIC RENEWAL + AUTOMATIC CHECK-IN + FINES + OVERDUE NOTICES
50 # 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
51 5    1 * * *  __KOHA_USER__ $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
52
53 # ADVANCE NOTICES
54 10   1 * * *  __KOHA_USER__  $KOHA_CRON_PATH/advance_notices.pl -c
55
56 # MEMBERSHIP_EXPIRY NOTICES
57
58 15   1 * * *  __KOHA_USER__  $KOHA_CRON_PATH/membership_expiry.pl -c
59
60 # SERIALS UPDATE
61 18   1 * * * __KOHA_USER__  $KOHA_CRON_PATH/serialsUpdate.pl -c
62
63 # PROCESS LONG OVERDUES
64 # updates item status from available to longoverdue for items long overdue
65 # 19 1 * * *  __KOHA_USER__  $KOHA_CRON_PATH/longoverdue.pl --lost 90=1 --confirm
66
67 # SEND EMAILS
68 15   * * * *  __KOHA_USER__  $KOHA_CRON_PATH/process_message_queue.pl
69
70 # Hourly holds queue updated
71 52   * * * *  __KOHA_USER__  $KOHA_CRON_PATH/holds/build_holds_queue.pl >/dev/null 2>&1
72
73 # Cancel expired holds
74 0 1 * * *  __KOHA_USER__ $KOHA_CRON_PATH/holds/cancel_expired_holds.pl >/dev/null 2>&1
75
76 # Auto unsuspend holds
77 0 1 * * *  __KOHA_USER__ $KOHA_CRON_PATH/holds/auto_unsuspend_holds.pl > /dev/null 2>&1
78
79 # Update popularity counts for biblio records
80 0 2 * * *  __KOHA_USER__ $KOHA_CRON_PATH/update_totalissues.pl --commit=1000 --use-stats --incremental --interval=1d >/dev/null 2>&1
81
82 # ZEBRA INDEX UPDATES with -z option, incremental index updates throughout the day
83 # for both authorities and bibs
84 */10 * * * *  __KOHA_USER__  $KOHA_CRON_PATH/../migration_tools/rebuild_zebra.pl -b -a -z >/dev/null
85
86 # clean up databases nightly.  Be sure not to run this with --sessions during a time when the system is in use!
87 16 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/cleanup_database.pl --confirm --sessions --zebraqueue 10 --list-invites --temp-uploads
88
89 # delete old purchase suggestions weekly. Replace XX with a number to define the age of suggestions to delete.
90 @weekly __KOHA_USER__  $KOHA_CRON_PATH/purge_suggestions.pl --confirm --days XX > /dev/null 2>&1
91
92 # share_usage_with_koha_community.pl every months
93 0 0 1 * *  __KOHA_USER__ $KOHA_CRON_PATH/share_usage_with_koha_community.pl
94
95 # run merge authorities
96 20 1 * * * __KOHA_USER__ $KOHA_CRON_PATH/merge_authorities.pl -b
97
98 # PLUGIN JOBS
99 10   1 * * *  __KOHA_USER__  $KOHA_CRON_PATH/plugins_nightly.pl