Difference between revisions of "Automated course backup"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Automated course backup.

(re-wording to clarify when courses are skipped)
 
(43 intermediate revisions by 13 users not shown)
Line 1: Line 1:
*The backup configuration page enables administrators to configure automated course backups and their schedule.
+
{{Backup}}
*Course backups are more expensive in terms of time and CPU usage. The recovery time to have your site running again is longer. Course backups are useful for obtaining "fresh" copies of courses to be re-used or distributed individually, however they should never be used as a primary backup system (unless your hosting doesn't allow the preferred site backups). In order to make scheduled course backups, you have to setup CRON to run periodically. Have a look at [[Installing Moodle#Set_up_cron|Set up cron]] for details.
+
A site administrator can configure a schedule for automated course backups in ''Administration > Site administration > > Courses > Backups > Automated backup setup''.
*Site backups, as explained in [[Upgrading_Moodle#Backup_important_data|upgrading Moodle]], are recommended in order to have all data saved with the best confidence and the shorter recovery time.
+
 
{{Moodle 1.6}}
+
Automated course backups runs the same functions as individual [[Course backup|course backups]]. It's a good idea to schedule backups for when your server isn't usually busy. Running the backup tool over all the courses can be processor-intensive, so you shouldn't run it when there are a lot of students trying to access the server. You should always alert users with an announcement on the first page that if they log on during the backup hours they may notice a decrease in performance. 
*From 1.6 onwards, course backups automatically skip courses which are unavailable to students AND have not been changed in the last month.
+
 
 +
In order to make scheduled backups, you have to set up CRON to run periodically. Please refer to the [[Cron|cron instructions]].
 +
 
 +
==Setting an automated course backup schedule==
 +
 
 +
To set the backup schedule:
 +
#Go to ''Administration > Site administration > > Courses > Backups > Automated backup setup''.
 +
#Set backup_auto_active to enabled.
 +
#Select the days of the week to run the backup.
 +
#Set the execution time for the backup process. For most servers, early morning will be the best time.  Keep in mind the time zone your server is using.
 +
#Set the "Save to..." path. If you can, choose a backup path on another machine or on a different drive than the one Moodle is on. You don’t want to lose your backups at the same time you lose your Moodle site if the drive fails. If you leave the field blank, then backup zip files will be saved in the backup folder of each course files folder. On a Linux server the path might look like: /home/(your user or domain)/public_html/archive/ or if it's below the publicly accessible folders: /home/(your user or domain)/archive/ if the path is not recognized a red X is shown after saving, otherwise a green check.
 +
#Choose whether to skip the backup of hidden courses or courses which have not been modified within a specified number of days, or not modified since the last backup (new settings in Moodle 2.4 onwards).
 +
#Click the "Save changes" button.
 +
 
 +
Once you've set up your backup schedule, Moodle will automatically create archives of all the courses on the server at the time you specified. Once the backup is complete, Moodle will send you an email describing the status of the backup.
 +
 
 +
===Use course names for your backups===
 +
 
 +
By default, the backups will be named according to the course ID, which is not always easily recognisable. Check the box ''Use course name in backup filename'' in ''Settings > Site Administration > Courses > Backups > Automated backup setup'' to have them saved with the course shortname instead.
 +
 
 +
==Backups report==
 +
 
 +
A last execution log of scheduled course backups can be found in ''Administration > Site administration > Reports > Backups''. It displays a list of all course backups made, the time taken to create them, their status (see below), and the next scheduled automated backup execution time.
 +
 
 +
Clicking the 'View logs' icon next to the course name (1 in screenshot below) will display a detailed backup log for a particular course, including date, hour and minute when each step of the backup was performed (2). This log is useful for troubleshooting backup errors.
 +
 
 +
[[File:backuplogs.png|thumb|500px|center|]]
 +
 
 +
===Backup status===
 +
 
 +
*'''OK''' - The course backup was successfully completed.
 +
*'''Skipped''' - The course was skipped (not backed up) because the course was unavailable to students and had not been changed in the last 31 days. This is not an error, but a feature designed to save process time.
 +
*'''Unfinished''' - The backup was not finished. This might have happened because the job to execute backups ran out of time or resources (e.g., the cron running the backups ran out of time before finishing all the courses waiting). The unfinished jobs should be completed when the next scheduled backups are repeated.  
 +
*'''Error''' - There were errors in the backup process for the course, so a backup was not completed. For additional details about the error (1) check the backup log for the affected course (i.e. click the 'View logs' icon next to the course name) or (2) back up the course manually with debugging turned on to see what error message is displayed.
 +
 
 +
==Course versus site backups==
 +
 
 +
*Automated course backups are more expensive in terms of time and CPU usage. The recovery time to have your site running again is longer.  
 +
*Course backups are useful for obtaining "fresh" copies of courses to be re-used or distributed individually, however they should never be used as a primary backup system (unless your hosting doesn't allow the preferred [[Site backup|site backups]]).  
  
 
==See also==
 
==See also==
 +
* [http://youtu.be/rg6rUuBwITo Moodle 2 Administration Courses ] MoodleBites video on YouTube
 +
* MDL-30725 Automated backups with external storage fill trashdir
 +
 +
Using Moodle forum discussions:
 +
*[http://moodle.org/mod/forum/discuss.php?d=167471 Where is the Moodle 2.0 "Course Backup Filearea"?]
 +
*[http://moodle.org/mod/forum/discuss.php?d=191275 the story of the mysteriously filling up hard disk]
  
*[[Backup FAQ]]
+
[[Category:Report]]
 +
[[Category:Site administration]]
  
[[Category:Administrator]]
+
[[eu:Ikastaroen_segurtasun-kopia_automatikoa]]
 +
[[fr:Sauvegarde_automatique_de_cours]]
 +
[[ja:自動コースバックアップ]]
 +
[[de:Automatische Kurssicherung]]
 +
[[es:Respaldo de curso automatizado]]

Latest revision as of 14:55, 7 October 2015

A site administrator can configure a schedule for automated course backups in Administration > Site administration > > Courses > Backups > Automated backup setup.

Automated course backups runs the same functions as individual course backups. It's a good idea to schedule backups for when your server isn't usually busy. Running the backup tool over all the courses can be processor-intensive, so you shouldn't run it when there are a lot of students trying to access the server. You should always alert users with an announcement on the first page that if they log on during the backup hours they may notice a decrease in performance.

In order to make scheduled backups, you have to set up CRON to run periodically. Please refer to the cron instructions.

Setting an automated course backup schedule

To set the backup schedule:

  1. Go to Administration > Site administration > > Courses > Backups > Automated backup setup.
  2. Set backup_auto_active to enabled.
  3. Select the days of the week to run the backup.
  4. Set the execution time for the backup process. For most servers, early morning will be the best time. Keep in mind the time zone your server is using.
  5. Set the "Save to..." path. If you can, choose a backup path on another machine or on a different drive than the one Moodle is on. You don’t want to lose your backups at the same time you lose your Moodle site if the drive fails. If you leave the field blank, then backup zip files will be saved in the backup folder of each course files folder. On a Linux server the path might look like: /home/(your user or domain)/public_html/archive/ or if it's below the publicly accessible folders: /home/(your user or domain)/archive/ if the path is not recognized a red X is shown after saving, otherwise a green check.
  6. Choose whether to skip the backup of hidden courses or courses which have not been modified within a specified number of days, or not modified since the last backup (new settings in Moodle 2.4 onwards).
  7. Click the "Save changes" button.

Once you've set up your backup schedule, Moodle will automatically create archives of all the courses on the server at the time you specified. Once the backup is complete, Moodle will send you an email describing the status of the backup.

Use course names for your backups

By default, the backups will be named according to the course ID, which is not always easily recognisable. Check the box Use course name in backup filename in Settings > Site Administration > Courses > Backups > Automated backup setup to have them saved with the course shortname instead.

Backups report

A last execution log of scheduled course backups can be found in Administration > Site administration > Reports > Backups. It displays a list of all course backups made, the time taken to create them, their status (see below), and the next scheduled automated backup execution time.

Clicking the 'View logs' icon next to the course name (1 in screenshot below) will display a detailed backup log for a particular course, including date, hour and minute when each step of the backup was performed (2). This log is useful for troubleshooting backup errors.

backuplogs.png

Backup status

  • OK - The course backup was successfully completed.
  • Skipped - The course was skipped (not backed up) because the course was unavailable to students and had not been changed in the last 31 days. This is not an error, but a feature designed to save process time.
  • Unfinished - The backup was not finished. This might have happened because the job to execute backups ran out of time or resources (e.g., the cron running the backups ran out of time before finishing all the courses waiting). The unfinished jobs should be completed when the next scheduled backups are repeated.
  • Error - There were errors in the backup process for the course, so a backup was not completed. For additional details about the error (1) check the backup log for the affected course (i.e. click the 'View logs' icon next to the course name) or (2) back up the course manually with debugging turned on to see what error message is displayed.

Course versus site backups

  • Automated course backups are more expensive in terms of time and CPU usage. The recovery time to have your site running again is longer.
  • Course backups are useful for obtaining "fresh" copies of courses to be re-used or distributed individually, however they should never be used as a primary backup system (unless your hosting doesn't allow the preferred site backups).

See also

Using Moodle forum discussions: