View source for SUNScholar/Daily Admin/6.X

<center>
 '''[[SUNScholar/Daily Admin|Back to Daily Admin]]'''
</center>

==Step 1. Login==
 http://wiki.lib.sun.ac.za/index.php/SUNScholar/Prepare_Ubuntu/S01
Click on the link above to find out how to login to the server and then return here.

==Step 2. Create "dspace" user crontab==
Edit the crontab, by typing the following in a terminal:

 su - dspace

 crontab -e
If asked to select an editor, choose '''nano'''

==Sample crontab==
Delete all of the contents and then copy and paste the following into the NANO text editor, and then save. See help for NANO above.

<pre>
## SAMPLE CRONTAB FOR A PRODUCTION DSPACE
## You obviously may wish to tweak this for your own installation,
## but this should give you an idea of what you likely wish to schedule via cron.
##
## NOTE: You may also need to add additional sysadmin related tasks to your crontab
## (e.g. zipping up old log files, or even removing old logs, etc).
 
####################
# GLOBAL VARIABLES #
####################
# Deliver cron email to the system administrator
MAILTO="root"

################
# HOURLY TASKS #
################
# (Recommended to be run multiple times per day, if possible)
# At a minimum these tasks should be run daily.

# Regenerate DSpace Sitemaps every 8 hours (12AM, 8AM, 4PM).
# SiteMaps ensure that your content is more findable in Google, Google Scholar, and other major search engines.
0 0,8,16 * * * $HOME/bin/dspace generate-sitemaps > /dev/null
 
###############
# DAILY TASKS #
###############
# (Recommended to be run once per day. Feel free to tweak the scheduled times below.)
 
# Update the OAI-PMH index with the newest content (and re-optimize that index) at midnight every day
# NOTE: ONLY NECESSARY IF YOU ARE RUNNING OAI-PMH
# (This ensures new content is available via OAI-PMH and ensures the OAI-PMH index is optimized for better performance)
0 0 * * * $HOME/bin/dspace oai import -o > /dev/null
 
# Clean and Update the Discovery indexes at midnight every day
# (This ensures that any deleted documents are cleaned from the Discovery search/browse index)
0 0 * * * $HOME/bin/dspace index-discovery > /dev/null
 
# Re-Optimize the Discovery indexes at 12:30 every day
# (This ensures that the Discovery Solr Index is re-optimized for better performance)
30 0 * * * $HOME/bin/dspace index-discovery -o > /dev/null
 
# Cleanup Web Spiders from DSpace Statistics Solr Index at 01:00 every day
# NOTE: ONLY NECESSARY IF YOU ARE RUNNING SOLR STATISTICS
# (This removes any known web spiders from your usage statistics)
0 1 * * * $HOME/bin/dspace stats-util -i > /dev/null
 
# Re-Optimize DSpace Statistics Solr Index at 01:30 every day
# NOTE: ONLY NECESSARY IF YOU ARE RUNNING SOLR STATISTICS 
# (This ensures that the Statistics Solr Index is re-optimized for better performance)
30 1 * * * $HOME/bin/dspace stats-util -o > /dev/null
 
# Send out subscription e-mails at 02:00 every day
# (This sends an email to any users who have "subscribed" to a Collection, notifying them of newly added content.)
0 2 * * * $HOME/bin/dspace sub-daily > /dev/null
 
# Run the media filter at 03:00 every day.
# (This task ensures that thumbnails are generated for newly add images,
# and also ensures full text search is available for newly added PDF/Word/PPT/HTML documents)
0 3 * * * $HOME/bin/dspace filter-media -q > $HOME/log/media-filter.log 2>&1

# Run any Curation Tasks queued from the Admin UI at 04:00 every day
# (Ensures that any curation task that an administrator "queued" from the Admin UI is executed
# asynchronously behind the scenes)
0 4 * * * $HOME/bin/dspace curate -q admin_ui > /dev/null

# Check for items to release from embargo in DSpace.
#(This applies to embargoes created with DSpace versions <= 3.2)  
0 5 * * * $HOME/bin/dspace embargo-lifter > $HOME/log/embargo-release.log 2>&1

# Update the local ORCID database with the latest information from the external ORCID database.
#(This only applies to DSpace versions => 5.2, if you enable ORCID lookups)
0 6 * * * $HOME/bin/dspace dsrun org.dspace.authority.UpdateAuthorities > $HOME/log/update-orcid-info.log 2>&1

################
# WEEKLY TASKS #
################
# (Recommended to be run once per week, but can be run more or less frequently, based on your local needs/policies)

# Run the checksum checker at 04:00 every Sunday
# By default it runs through every file (-l) and also prunes old results (-p)
# (This re-verifies the checksums of all files stored in DSpace. If any files have been changed/corrupted, checksums will differ.)
#0 4 * * * $HOME/bin/dspace checker -l -p > /dev/null
#
# NOTE: LARGER SITES MAY WISH TO USE DIFFERENT OPTIONS. The above "-l" option tells DSpace to check *everything*.
# If your site is very large, you may need to only check a portion of your content per week. The below commented-out task
# would instead check all the content it can within *one hour*. The next week it would start again where it left off.
0 4 * * 0 $HOME/bin/dspace checker -d 1h -p > /dev/null
  
# Mail the results of the checksum checker (see above) to the configured "mail.admin" at 05:00 every Sunday.
# (This ensures the system administrator is notified whether any checksums were found to be different.)
0 5 * * 0 $HOME/bin/dspace checker-emailer > /dev/null

# Run DSpace statistical analysis tools (12months takes approx 40secs)
30 0 * * 0 $HOME/bin/dspace stat-general  > /dev/null
35 0 * * 0 $HOME/bin/dspace stat-monthly  > /dev/null

# Generate DSpace statistical analysis reports
00 1 * * 0 $HOME/bin/dspace stat-report-general  > /dev/null
05 1 * * 0 $HOME/bin/dspace stat-report-monthly  > /dev/null
 
#################
# MONTHLY TASKS #
#################
# (Recommended to be run once per month, but can be run more or less frequently, based on your local needs/policies)

# Permanently delete any bitstreams flagged as "deleted" in DSpace, on the first of every month at 01:00
# (This ensures that any files which were deleted from DSpace are actually removed from your local filesystem.
#  By default they are just marked as deleted, but are not removed from the filesystem.)
0 1 1 * * $HOME/bin/dspace cleanup > /dev/null

# Remove all log files which are more than 30 days old
# on the first of every month
01 0 1 * * find $HOME/dspace/log/*.log.* -mtime +30 -exec rm {} \;
 
################
# YEARLY TASKS #
################
# (Recommended to be run once per year)

# At 2:00AM every January 1, "shard" the DSpace Statistics Solr index.
# This ensures each year has its own Solr index, which improves performance.
# NOTE: ONLY NECESSARY IF YOU ARE RUNNING SOLR STATISTICS
# NOTE: This is scheduled here for 2:00AM so that it happens *after* the daily cleaning & re-optimization of this index.
0 2 1 1 * $HOME/bin/dspace stats-util -s > /dev/null

################
# HOUSEKEEPING #
################
# (Recommended to be run daily)

# Delete any ~/config/*/*.old files more than 30 days old (created by "ant update")
0 2 1 * * find $HOME/config -name "*-*-*.old" -mtime +30 -exec rm {} \;
# Delete any ~/*.bak-*-*/ directories more than 30 days old (created by "ant update")
0 2 1 * * find $HOME/*.bak-*-* -maxdepth 0 -type d -mtime +30 -exec rm -rf {} \;
</pre>

Save and exit the file.

==System Log==
To enable logging of cron events, edit the following file:
 sudo nano /etc/rsyslog.d/50-default.conf
Enable the cron log by removing hash (#) in front of <tt>'''cron.*'''</tt>.

See example below.
<pre>
#
# First some standard log files.  Log by facility.
#
auth,authpriv.*                 /var/log/auth.log
*.*;auth,authpriv.none          -/var/log/syslog
cron.*                          -/var/log/cron.log
</pre>

Now restart the syslog service as follows:
 sudo service rsyslog restart

==References==
*https://wiki.duraspace.org/display/DSDOC5x/Command+Line+Operations
*https://wiki.duraspace.org/display/DSDOC5x/Scheduled+Tasks+via+Cron
*https://github.com/DSpace/demo.dspace.org/blob/master/scripts/linux/crontab

[[Category:System Administration]]
[[Category:Installation]]
__NOTOC__