System backups

Adobe Commerce and Magento Open Source give you the ability to back up different parts of the system—such as the file system, database, and media files—and to roll back automatically. A record for each backup appears in the grid on the Backups page. Deleting a record from the list deletes the archived file as well. Database backup files are compressed using the GZ format. For the system backups and the database and media backups, the TGZ format is used. As a best practice, you should restrict access to backup tools, and back up before installing extensions and updates.

  • Restrict access to backup tools. Access to the backups and roll back management tool can be restricted by configuring user roles for backup and roll back resources. To restrict access, leave the corresponding checkbox unselected. To give access to roll back resources, you must grant access to backup resources as well.

  • Back up before installing extensions and updates. Always perform a backup before you install an extension or update.

IMPORTANT

Disabled feature: Backup is disabled by default. Enabling this function may require developer assistance. See the following Installation Guide topic to enable backups: Back up and roll back the file system, media, and database.

NOTE

Deprecation notice: Backup features are deprecated as of v2.3.0. It is recommended that all merchants investigate additional backup technologies and binary backup tools (such as Percona XtraBackup).

Enable and schedule backups

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Advanced and choose System.

  3. Expand Expansion selector the Backup Settings.

  4. Set Enabled Schedule Backup to Yes.

  5. To schedule automatic beckups, set the scheduling options:

    • Set Enabled Schedule Backup to Yes.
    • Set Scheduled Backup Type to the type of backup to run at the scheduled interval.
    • Set Start Time to the time of day to run the backup operation.
    • Set Frequency to Daily, Weekly, or Monthly.
    • Set Maintenance Mode to Yes.
    Advanced configuration - backups

  6. When complete, click Save Config.

Create a backup

  1. On the Admin sidebar, go to System > Tools > Backups.

  2. In the upper-right corner, click the type of backup you want to create:

    • System Backup - Creates a complete backup of the database and the file system. During the process, you can choose to include the media folder in the backup.

    • Database and Media Backup - Creates a backup of the database and the media folder.

    • Database Backup - Creates a backup of the database.

    System tools - backups

  3. To put the store into maintenance mode during the backup, select the checkbox.

    When the backup is complete, maintenance mode is turned off automatically.

  4. For a system backup, select the Include Media folder to System Backup checkbox to include the media folder.

  5. When prompted, confirm the action.

On this page