bench backup

The bench backup command creates a backup of a Frappe site. By default, it generates a database dump, compresses it, and stores it in the site’s backup directory. You can also include public and private files, customize backup locations, and back up specific DocTypes.

Command Syntax

bench backup [OPTIONS]

What the Command Does

When executed, the command performs the following tasks:

1. Creates a database dump of the selected site.
2. Compresses the database backup.
3. Saves the backup in the default directory:

sites/{site}/private/backups

Optionally, the command can also include public files, private files, configuration files, or selected DocTypes in the backup.

Command Options

Available Flags

• --ignore-backup-conf — Ignore backup include and exclude settings defined in the site configuration.
• --with-files — Include public and private files in the backup.
• --compress — Compress public and private files into .tgz archives.
• --verbose — Display detailed output during the backup process.

Examples

1. Create a Backup Including Public and Private Files

bench --site mysite.local backup --with-files

2. Compress File Backups

bench --site mysite.local backup --with-files --compress

The public and private files are compressed into .tgz archives instead of the default .tar format.

3. Save Backups to a Custom Location

bench --site mysite.local backup --backup-path /home/frappe/backups

4. Specify Separate Backup Locations

bench --site mysite.local backup --with-files \
    --backup-path-conf /backup/config \
    --backup-path-db /backup/database \
    --backup-path-files /backup/public \
    --backup-path-private-files /backup/private

5. Display Detailed Backup Information

bench --site mysite.local backup --verbose

6. Back Up Only Selected DocTypes

bench --site mysite.local backup \
    --only "ToDo,Note,Task,Project,Sales Invoice"

Only the specified DocTypes are included in the database backup.

7. Exclude Specific DocTypes

bench --site mysite.local backup \
    --exclude "Error Log,Access Log,Activity Log,Version"

Useful for excluding frequently changing log tables to reduce backup size.

8. Ignore Backup Configuration Settings

bench --site mysite.local backup --ignore-backup-conf

Creates a complete backup without considering any include or exclude rules defined in frappe.conf.backup.*.