This module enhances the database backup functionality in Odoo by introducing support for storing backups as files using the fsspec library. It is designed to address the need for reliable and flexible backup solutions, enabling businesses to safeguard their data by storing backups on various filesystems, including cloud storage providers, network drives, and local secure storage.
By integrating with the fs_file addon from the OCA storage repository, this module allows users to automate the backup process and store the resulting files in a configured filesystem. It provides an easy-to-use interface for configuring backup methods, managing stored backups, and ensuring data integrity for disaster recovery or multi-environment setups.
auto_awesome What this module does
AI-generated from the code · Odoo 17.0Adds a new 'Fs File' backup method to the database backup configuration, letting Odoo store backups as files on a configured filesystem and notify a responsible user when a backup is ready to download.
This module extends the existing database backup configuration (db.backup) with an extra backup method called 'Fs File'. When a backup configuration uses this method, the backup file is written to a filesystem storage instead of only being kept as a regular database dump.
- On the backup configuration form you can pick the new 'Fs File' method, choose a responsible user to be notified, and see a 'Backups' button that opens the list of files created by that configuration.
- A new 'Fs File Backups' menu lists all stored backup files, with their filename, related backup configuration and creation date.
- Each stored backup file is tracked with messages and activities, so you can follow what happened and when.
- When a backup runs, the system creates the backup file, then schedules a 'Download Backup' activity for the responsible user (or the current user if none is set) with a link to download the file.
- A validation prevents saving a backup configuration with the 'Fs File' method if no filesystem storage is configured for the backup file field.
- Backups older than the configured retention period are marked as expired and are automatically removed from the storage during cleanup.
The module touches the backup configuration, the new backup file records, filesystem storage settings, and mail activities.
Depends on
Models and fields (2)
- db.backup · extends an existing modelmethod, responsible_id, fs_file_backup_ids (Fs File Backups), fs_file_backup_count
- db.backup.fs.file · new modelname (Backup Filename), is_expired, db_backup_id (DB Backup)
Text generated by AI (DeepSeek) from reading the Odoo 17.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-03Confirmation status: 1 confirmed, 8 with no information of 9 versions.
Sources · Odoo 17.0
Confirmed on 2026-11-03 in branch 17.0 of OCA/server-tools.
terminal Installation and usage
OCA documentation · Odoo 17.0Installation
Source · Odoo 17.0This addon itself does not introduce any dependencies, but its dependencies may require additional packages.:wa
Configuration
Source · Odoo 17.0- Review Documentation for Dependencies Before configuring the module, ensure you have reviewed the documentation for the following modules:
fs_attachmentfs_storageThese modules provide the necessary setup for file storage and attachment handling.- Configure File Storage
- Navigate to Settings > Technical > FS Storage.
- Create or select an existing storage configuration.
- Ensure the storage is properly set up and tested for accessibility.
- Link Backup File field to Storage
- While configuring the file storage in Settings > Technical > FS Storage, ensure that the
backup_filefrom thedb.backup.fs.filemodel is listed under theFieldfield. - This step is part of the storage configuration process.
- Save the changes after verifying the setup.
- Verify Configuration
- Perform a test backup to ensure the files are being stored in the correct location.
- Check the logs for any errors or warnings.
By following these steps, you will ensure that the module is properly configured for storing backups in the desired file storage system.
Usage
Source · Odoo 17.0This module extends the functionality of the database backup system in Odoo by introducing a new backup method: Fs File. This method allows storing database backups as files using an FSSPEC implementation.
How to Use the Module
- Configure the Backup Method
- Navigate to Settings > Technical > Database Structure > Automated Backups.
- Create or edit a backup configuration.
- In the Backup Method field, select Fs File.
- Configure other fields as needed, such as the backup format and retention settings.
- Save the configuration.
- Perform a Backup
- From the list of backup configurations, select the one configured with the Fs File method.
- Click the Backup Now button to initiate the backup process.
- The backup will be stored as a file in the configured FSSPEC storage.
- View Fs File Backups
- Open the backup configuration form view.
- In the top-right corner, you will see a Backups stat button (if backups exist).
- Click the Backups button to view the list of Fs File backups associated with the configuration.
- Manage Fs File Backups
- In the Fs File backups list view, you can see details such as the backup filename and associated database backup configuration.
- Use this view to manage or download backups as needed.
Screenshots
- Backup Configuration Form View
- Fs File Backups List View
Notes
- Ensure that the FSSPEC storage is properly configured before using the Fs File method.
- This module adds a new stat button in the backup configuration form view to quickly access Fs File backups.
Installation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.
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.