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

Course backup: Difference between revisions

From MoodleDocs
(link to forum post (thanks Ken Task))
 
(59 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Course admin}}
{{Backup}}
A course can be saved with some or all of its parts by using the course backup.  Typically, the site administrator will set a schedule of [[Automated course backup|automated course backups]] for the whole site.  A teacher with editing privileges can create a backup or download an existing backup for safe keeping, or for use on another Moodle site.  See the screencast  [https://www.youtube.com/watch?v=BVHHC-wBhEM Course backup: Save and reuse your course] for information on how to back up your course as a teacher.


Generally, you will not have to worry about '''course backups''', as the primary Moodle administrator will have set a schedule of site wide backups. However, as a teacher with editing privileges, it is good practice to download a recent backup to your own computer for additional protection.
==Backing up a course==


To backup a course


==Creating a course backup==
* Go to ''Administration > Course administration > Backup''
[[Image:Course_backup.jpg|thumb|Creating a course backup - page 1]][[Image:Course_backup_s2.jpg|thumb|Creating a course backup - page 2]][[Image:Course_backup_s3.jpg|thumb|Creating a course backup - page 3]]
* Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to [[Backup of user data|include users]], anonymize user information, or include user role assignments, user files, comments, user completion details, course logs and grade history in the backup.
To create a course backup:
* Schema settings  - Select/deselect specific items to include in backup, then click the Next button.
#Click Backup in the course administration block.
#Choose which activities you want to include in the backup, and whether to include user data, by using the Include All/None links at the top of the page and/or by selecting the checkboxes next to each module or activity name. User data consists of all student files, submissions, forum postings, glossary entries, etc.
#Select backup options (see below), then click the Continue button to start the backup process.
#On the next page, you can preview the files and users that Moodle will include in the backup and, if you wish, change the suggested backup filename, which is backup-COURSESHORTNAME-DATE-TIME.zip.
#Click the Continue button.
#On the next page, the progress of the backup is displayed together with a report if it was successful. You should see the message "Backup completed successfully" at the bottom of the page. Click the Continue button.
#You will then be taken to the backupdata directory in the files area for your course. Click the filename of the backup file to download it to your desktop.


==Backup options==
* If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
* Metacourse - If you are backing up the content of a [[Metacourses|metacourse]], you may enable this option so that that relations between the courses will be exported and the restore process will try to rebuild them in the destination server.
 
* Users - Whether you want to backup the content concerning all the registered students in your site, only course students or no students at all.  
{|
* Logs - This backs up all course activity logs.
|[[File:26backuprestore1.png|thumb|Back up screen with option to select all or none]]
* User files - This backs up all student submissions for assignments and other file uploads.
|
* Course files - This backs up any file stored in the [[Files|files]] area for the course.
|[[File:26backuprestore2.png|thumb|Back up screen with option to select activity types]]
|}
 
* Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
* Complete - Click the Continue button
 
A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form ''backup-moodle2-course-coursename-date-hour.mbz'', ending in ''-nu.mbz'' when backed up with no users and ''-an.mbz''  with anonymized names.
 
===Quick backup===
{{New features}}
If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.
[[File:jumptofinalstep.png|center]]
 
==Anonymizing user information==
 
Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example  "Max Manager" might become  "anonfirstname4 anonlastname4".
 
==Backup and restore from 1.9 to 2==
 
Courses created in 1.9 can be backed up and then restored into a 2.1 Moodle or later but blocks are not currently restored and nor is user data (such as forum posts, grades, submissions etc).
 
==Backup and restore of assignments from Moodle 2.2 and older==
 
The assignment activity module was completely rewritten in Moodle 2.3. Thus, assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable. See the section 'Restoring course backups from Moodle 2.2 and older' in [[Assignment upgrade tool]] for details of what to do.
 
==Backing up courses larger than 4GB==
Site administrators can enable a compression format for .mbz files (internally stored as a .tar.gz file) from ''Site administration>Development>Experimental>Experimental settings'' which removes the 4GB backup size restriction and may improve performance. If this box is checked then future courses will be backed up in this format. It won't affect restoring courses.
 
==CLI backup script==
Performs via command line a backup of the given course.
 
===Options===
* --courseid=INTEGER (Course ID for backup.)
* --courseshortname=STRING (Course shortname for backup.)
* --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
* -h, --help (Print out this help.)
 
===Example===
\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/
 
==Tips and tricks==
* Lose content after a restore in Moodle 2.0 ?  Do you see topic headings that say "Orphaned activities"?  Solution: Go to course settings and increase the number of topic sections and things will return to normal.


==Creative uses==
==Creative uses==
The backup and restore processes can offer the teacher and administrators many creative solutions.
The backup and restore processes can offer the teacher and administrators many creative solutions.
*Duplicating courses or specific activities in one course to another course
*Duplicating courses or specific activities in one course to another course (similar to Import)
*Updating a production Moodle site course, with material from a localhost site course
*Updating a production Moodle site course, with material from a localhost site course
*Transferring a course to a new Moodle site.
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*In earlier versions of Moodle, a way of rolling a course forward without past student activity
*Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.
==General backup defaults==


==See also==
Default settings for course backups can be set by a site administrator in ''Administration > Site administration > Courses > Backups > General backup defaults''.
 
Selected settings may be locked, so that they cannot be changed when creating a course backup.
 
By selecting a time in the "Keep logs for.."  dropdown, it is possible to specify how long backup  logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.


*[[Restore]]
==Course backup capabilities==
*[[Backup settings]] - for administrators
*[[Backup and restore FAQ]]
*[[Roll courses forward]]
*[[Front Page]] trick to backup Front page in earlier version of Moodle
*[http://www.youtube.com/watch?v=ZrdM_KOr530 Creating course backups video]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=59581 Location of Backup Files] forum discussion


[[Category:Backup]]
*[[Capabilities/moodle/backup:anonymise|Anonymise user data on backup]]
*[[Capabilities/moodle/backup:backupcourse|Backup courses]]
*[[Capabilities/moodle/backup:backupsection|Backup sections]]
*[[Capabilities/moodle/backup:backuptargethub|Backup for hub]]
*[[Capabilities/moodle/backup:backuptargetimport|Backup for import]]
*[[Capabilities/moodle/backup:configure|Configure backup options]]
*[[Capabilities/moodle/backup:downloadfile|Download files from backup areas]]
*[[Capabilities/moodle/backup:userinfo|Backup user data]]


==See also==
*Forum post [https://moodle.org/mod/forum/discuss.php?d=310227#p1241735 Back up via command line]
*[[Course restore]]
*[[Backup of user data]]
*[[Activity backup]]
* [http://youtu.be/rg6rUuBwITo Moodle 2 Administration Courses] MoodleBites video on YouTube
[[de:Kurssicherung]]
[[es:Respaldo del curso]]
[[eu:Ikastaroaren_Segurtasun-kopia]]
[[fr:Sauvegarde de cours]]
[[fr:Sauvegarde de cours]]
[[es:backup/backup]]
[[ca:backup/backup]]
[[ja:コースバックアップ]]
[[ja:コースバックアップ]]
[[de:Kurssicherung]]

Latest revision as of 10:40, 25 March 2015

A course can be saved with some or all of its parts by using the course backup. Typically, the site administrator will set a schedule of automated course backups for the whole site. A teacher with editing privileges can create a backup or download an existing backup for safe keeping, or for use on another Moodle site. See the screencast Course backup: Save and reuse your course for information on how to back up your course as a teacher.

Backing up a course

To backup a course

  • Go to Administration > Course administration > Backup
  • Initial settings - Select activities, blocks, filters and other items as required then click the Next button. Users with appropriate permissions, such as administrators and managers, can choose whether to include users, anonymize user information, or include user role assignments, user files, comments, user completion details, course logs and grade history in the backup.
  • Schema settings - Select/deselect specific items to include in backup, then click the Next button.
  • If desired, select specific types of activity to be backed up by clicking the link 'Show type options'
Back up screen with option to select all or none
Back up screen with option to select activity types
  • Confirmation and review - Check that everything is as required, using the Previous button if necessary, otherwise click the 'Perform backup' button
  • Complete - Click the Continue button

A backup file (with distinctive .mbz extension to avoid confusion with .zip files) is then saved in the course backup area. Backup file names are of the form backup-moodle2-course-coursename-date-hour.mbz, ending in -nu.mbz when backed up with no users and -an.mbz with anonymized names.

Quick backup

New feature
in Moodle 2.8!

If you are satisfied with the default settings and don't wish to go through all the backup screens, you can simply click 'Jump to final step' to perform the backup.

jumptofinalstep.png

Anonymizing user information

Anonymize user information is a backup feature which "protects user identities" by making each user anonymous. If this box is checked in the backup initial settings, Moodle will substitute aliases for real names, substituting @doesntexist.com email addresses and so forth. For example "Max Manager" might become "anonfirstname4 anonlastname4".

Backup and restore from 1.9 to 2

Courses created in 1.9 can be backed up and then restored into a 2.1 Moodle or later but blocks are not currently restored and nor is user data (such as forum posts, grades, submissions etc).

Backup and restore of assignments from Moodle 2.2 and older

The assignment activity module was completely rewritten in Moodle 2.3. Thus, assignments from Moodle 2.2 and older (e.g. from Moodle 1.9) need to be upgraded in order to continue being usable. See the section 'Restoring course backups from Moodle 2.2 and older' in Assignment upgrade tool for details of what to do.

Backing up courses larger than 4GB

Site administrators can enable a compression format for .mbz files (internally stored as a .tar.gz file) from Site administration>Development>Experimental>Experimental settings which removes the 4GB backup size restriction and may improve performance. If this box is checked then future courses will be backed up in this format. It won't affect restoring courses.

CLI backup script

Performs via command line a backup of the given course.

Options

  • --courseid=INTEGER (Course ID for backup.)
  • --courseshortname=STRING (Course shortname for backup.)
  • --destination=STRING (Path where to store backup file. If not set the backup will be stored within the course backup file area.)
  • -h, --help (Print out this help.)

Example

\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/

Tips and tricks

  • Lose content after a restore in Moodle 2.0 ? Do you see topic headings that say "Orphaned activities"? Solution: Go to course settings and increase the number of topic sections and things will return to normal.

Creative uses

The backup and restore processes can offer the teacher and administrators many creative solutions.

  • Duplicating courses or specific activities in one course to another course (similar to Import)
  • Updating a production Moodle site course, with material from a localhost site course
  • Transferring a course to a new Moodle site.
  • In earlier versions of Moodle, a way of rolling a course forward without past student activity
  • Creating a blank activity, save just that activity and then restore it to the course or another course one or more times.

General backup defaults

Default settings for course backups can be set by a site administrator in Administration > Site administration > Courses > Backups > General backup defaults.

Selected settings may be locked, so that they cannot be changed when creating a course backup.

By selecting a time in the "Keep logs for.." dropdown, it is possible to specify how long backup logs information is kept before being deleted. As this information may be very large, it is recommended the length of time chosen be quite short.

Course backup capabilities

See also