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.
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.
- 1 Backing up a course
- 2 Anonymizing user information
- 3 Backup and restore from 1.9 to 2
- 4 Backup and restore of assignments from Moodle 2.2 and older
- 5 Backing up courses larger than 4GB
- 6 CLI backup script
- 7 Tips and tricks
- 8 Creative uses
- 9 General backup defaults
- 10 Course backup capabilities
- 11 See also
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'
- 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.
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.
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.
- --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.)
\$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.
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
- Anonymise user data on backup
- Backup courses
- Backup sections
- Backup for hub
- Backup for import
- Configure backup options
- Download files from backup areas
- Backup user data