OdooWiki OCA HUB

Database Auto-Backup

auto_backup folder_open OCA/server-tools open_in_new
Tools License: AGPL-3

A tool for all your back-ups, internal and external!

auto_awesome What this module does

AI-generated from the code · Odoo 19.0

Create and schedule automatic database backups, stored on the server disk or on a remote SFTP server, with optional automatic deletion of old backup files.

This module adds a new screen called Automated Backups where you define one or more backup configurations. Each configuration says where the backup file is stored, how long it is kept, and in which format it is produced.

  • Storage method: local disk or a remote SFTP server. For SFTP you fill in host, port, user, password and optionally a private key file, and a button lets you test the connection before saving.
  • Format: a zip file that includes the filestore, or a plain database dump without the filestore.
  • Retention: a number of days after which older backup files are deleted automatically; 0 disables deletion.
  • A button on the form runs the backup immediately, and a server action named Execute backup(s) is also available from the list view.

The module also creates a scheduled action called Backup Scheduler, which by default runs once a day and executes all configured backups. Each configuration keeps a log of what happened: a message is posted on the record when a backup succeeds or fails, and when the cleanup of old files fails. A safety check prevents you from saving backups inside the filestore folder, and the retention days cannot be negative. Configuration names must be unique.

Access is restricted: only system administrators can create or change backup configurations, while other managers can only read them.

Depends on

mail

Required by other modules

Menus it adds

backup_conf_menu
Models and fields (1)
  • db.backup · new modelname, folder, method, sftp_host (SFTP Server), sftp_port (SFTP Port), sftp_user (Username in the SFTP Server), days_to_keep, backup_format, sftp_password (SFTP Password), sftp_private_key (Private key location)

Text generated by AI (DeepSeek) from reading the Odoo 19.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 8 confirmed, 1 with no information of 9 versions.

Sources · Odoo 18.0

Confirmed on 2026-11-03 in branch 18.0 of OCA/server-tools.

terminal Installation and usage

OCA documentation · Odoo 19.0

Before installing this module, you need to execute:

pip3 install pysftp==0.2.9

Go to Settings -\> Database Structure -\> Automated Backup to create your configurations for each database that you needed to backups.

Keep your Odoo data safe with this module. Take automated back-ups, remove them automatically and even write them to an external server through an encrypted tunnel. You can even specify how long local backups and external backups should be kept, automatically!

Connect with an FTP Server

Keep your data safe, through an SSH tunnel!

Want to go even further and write your backups to an external server? You can with this module! Specify the credentials to the server, specify a path and everything will be backed up automatically. This is done through an SSH (encrypted) tunnel, thanks to pysftp, so your data is safe!

Test connection

Checks your credentials in one click

Want to make sure if the connection details are correct and if Odoo can automatically write them to the remote server? Simply click on the ‘Test SFTP Connection’ button and you will get message telling you if everything is OK, or what is wrong!

E-mail on backup failure

Stay informed of problems, automatically!

Do you want to know if the database backup succeeded or failed? Subscribe to the corresponding backup setting notification type.

Run backups when you want

From the backups configuration list, press More \> Execute backup(s) to manually execute the selected processes.

[](https://runbot.odoo-community.org/runbot/149/11.0)

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.