Product Guide
Backups
Overview

Backups

Backups protect your Odoo data by creating copies of your database and files. If something goes wrong, you can restore your environment to a previous state.

Each backup is a snapshot containing your database (all business data like customers, orders, invoices) and your filestore (uploaded documents, images, and attachments). Backups are compressed and stored in your configured cloud storage.


Viewing Backups

Environment Backups

View backups for a specific environment:

  1. Go to your Project > Environment
  2. Click the Backup Management tab
  3. See all backups for this environment

Organization Backups Dashboard

View all backups across your organization:

  1. Go to Backups in the left sidebar
  2. Filter by status, type, or environment
  3. Search by environment or project name

Creating a Manual Backup

Create a backup anytime you want to save the current state of your environment.

  1. Go to your Environment > Backup Management tab
  2. Click the Create Backup button
  3. Configure your backup options:
    • Storage Location - Choose where to save the backup
    • Include Filestore - Keep this enabled to include all uploaded files
    • Retention Period - How long to keep the backup (Daily, Weekly, Monthly, Yearly, or Permanent)
  4. Click Create Backup
  5. Monitor progress in real-time

Always create a manual backup before major changes like upgrading Odoo or installing new modules.


Automatic Backups

Set up automatic backups so you never have to remember.

  1. Go to your environment's Backup Management tab
  2. Click Backup Policy
  3. Enable automatic backups with the toggle
  4. Set your preferred schedule using presets or cron expression
  5. Configure GFS retention (how long to keep backups):
    • Daily backups - Kept for 7 days by default
    • Weekly backups - Kept for 4 weeks by default
    • Monthly backups - Kept for 12 months by default
    • Yearly backups - Kept for 2 years by default
  6. Configure notifications (optional):
    • Notify on successful backup
    • Notify on failed backup
  7. Save your policy

Once configured, backups run automatically on your schedule.


Backup Types

TypeDescriptionWhen Created
ManualCreated by clicking Create BackupOn demand
ScheduledCreated automatically by backup policyBased on schedule
Pre-RestoreSafety backup before a restore operationWhen safety backup enabled
Pre-UpgradeCreated before Odoo version upgradeDuring upgrades
Pre-DestroyCreated before environment destructionDuring destroy

Restoring from a Backup

Restore your environment to a previous state when needed.

  1. Go to your environment's Backup Management tab
  2. Find the backup you want to restore
  3. Click the Restore button
  4. Choose where to restore:
    • Original Environment - Restore to the same environment (rollback)
    • Different Environment - Restore to another compatible environment
    • New Environment - Create a fresh environment from the backup
    • Different Server - Restore to an environment on another server
  5. Review the options:
    • Safety backup first - Recommended! Saves current state before restoring
    • Include filestore - Restore uploaded files along with the database
  6. Type "RESTORE" to confirm
  7. Click Restore Backup and wait for completion

Warning: Restoring replaces all current data with the backup data. Always create a safety backup first.


Downloading a Backup

Download backup files to your computer for external storage or migration.

  1. Go to your environment's Backup Management tab
  2. Find the backup you want to download
  3. Click the download icon
  4. Configure download options:
    • URL Expiration: 15 minutes, 30 minutes, 1 hour, 2 hours, or 24 hours
  5. Download individual files:
    • Database - backup-{id}-database.sql.gz
    • Filestore - backup-{id}-filestore.tar.gz
    • Manifest - backup-{id}-manifest.json

Download URLs expire after your selected duration for security.


Deleting Old Backups

Remove backups you no longer need to free up storage space.

  1. Go to your environment's Backup Management tab
  2. Find the backup you want to delete
  3. Click the delete icon
  4. Confirm the deletion

Note: Backups set to "Permanent" retention will not be automatically deleted. You must delete them manually.


Backup Status

StatusMeaning
PendingBackup is queued and waiting to start
In ProgressBackup is currently being created
UploadingBackup is being uploaded to storage
CompletedBackup finished successfully and is ready to use
FailedSomething went wrong (check error message)
ExpiredBackup has passed its retention date and will be cleaned up

Completed backups show a verification badge indicating the backup was validated after upload.


Backup Compliance

The Dashboard displays a Backup Compliance percentage that shows how well your organization maintains backups across all environments.

How Compliance is Calculated

Backup Compliance only considers environments that have backups enabled. Environments with disabled backup policies are excluded from the calculation.

Formula: (Environments with recent successful backup) / (Environments with backups enabled) x 100%

Example:

  • You have 10 environments total
  • 8 environments have backups enabled
  • 2 environments have backups disabled (dev/test)
  • 6 of the 8 enabled environments have a recent successful backup

Compliance = 6 / 8 x 100% = 75%

The 2 disabled environments don't count toward the metric at all.

Why Some Environments Are Excluded

Environments with enabled: false in their backup policy are excluded because:

  1. Development environments often don't need backups since data is temporary
  2. Test environments are frequently reset and may not require persistence
  3. Staging environments may be intentionally excluded when they mirror production data

This prevents disabled dev/test environments from dragging down your compliance score.

Improving Your Compliance Score

To reach 100% compliance:

  1. Go to each environment with backups enabled
  2. Ensure the backup schedule is running
  3. Check that backups complete successfully
  4. Verify storage is configured and accessible

A low compliance score typically means backup failures from storage issues, enabled policies with no recent runs, or newly created environments that haven't run their first backup yet.


Backup Policy Sources

Each environment gets its backup policy from one of two sources:

Custom Backup Policy

The environment has its own dedicated backup policy. Use this when an environment needs a different schedule or retention settings than the org default.

To set a custom policy:

  1. Go to Environment > Backup Management tab
  2. Click Backup Policy
  3. Configure your custom settings
  4. Save the policy

Organization Default Policy

The environment uses the organization's default backup policy. This is efficient when most environments need the same schedule and you want centralized management.

To configure the organization default:

  1. Go to Settings > Backups tab
  2. Configure the default backup policy
  3. All environments without custom policies will use these settings

Backup Policy Settings

A backup policy controls how and when backups are created for an environment.

SettingDescriptionExample
EnabledWhether automatic backups are activetrue or false
ScheduleCron expression for backup timing0 2 * * * (daily at 2 AM)
Retention DaysHow long to keep backups30 days

Enabling/Disabling Backup Policies

When enabled: false:

  • No automatic backups will be created
  • The environment won't count toward Backup Compliance
  • Manual backups can still be created

When enabled: true:

  • Backups run according to the schedule
  • The environment counts toward Backup Compliance
  • Failures trigger notifications (if configured)

Disable backups for development environments that reset frequently or contain no important data. This reduces storage costs and keeps your compliance metric meaningful.


Where Backups Are Stored

Backups are saved to cloud storage configured in your organization settings. Supported providers:

  • AWS S3 - Amazon's cloud storage
  • Cloudflare R2 - Cost-effective with no download fees
  • Backblaze B2 - Low-cost archival storage
  • DigitalOcean Spaces - S3-compatible storage
  • MinIO - Self-hosted S3-compatible storage
  • FTP - Traditional file transfer
  • SFTP - Secure file transfer over SSH

Your organization administrator can configure storage providers in Settings > Storage.