odoo-backup-strategy

Imported from sickn33/agentic-awesome-skills (skills/odoo-backup-strategy/SKILL.md). Install upstream with npx skills add sickn33/agentic-awesome-skills --skill odoo-backup-strategy. Copyright stays with the author.

Odoo Backup Strategy

Overview

A complete Odoo backup must include both the PostgreSQL database and the filestore (attachments, images). This skill covers manual and automated backup procedures, offsite storage, and the correct restore sequence to bring a down Odoo instance back online.

When to Use This Skill

• Setting up a backup strategy for a production Odoo instance.
• Automating daily backups with shell scripts and cron.
• Restoring Odoo after a server failure or data corruption event.
• Diagnosing a failed backup or corrupt restore.

How It Works

1. Activate: Mention @odoo-backup-strategy and describe your server environment.
2. Generate: Receive a complete backup script tailored to your setup.
3. Restore: Get step-by-step restore instructions for any failure scenario.

Examples

Example 1: Manual Database + Filestore Backup

#!/bin/bash
# backup_odoo.sh
set -euo pipefail
umask 077
# Quiesce Odoo and all writers for this whole dump+archive interval,
# or use a storage/database snapshot procedure proven consistent.

DATE=$(date +%Y%m%d_%H%M%S)
DB_NAME="odoo"
DB_USER="odoo"
FILESTORE_PATH="/var/lib/odoo/.local/share/Odoo/filestore/$DB_NAME"
BACKUP_DIR="/backups/odoo"

mkdir -p "$BACKUP_DIR"

# Step 1: Dump the database
pg_dump -U "$DB_USER" -Fc "$DB_NAME" > "$BACKUP_DIR/db_$DATE.dump"

# Step 2: Archive the filestore
tar -czf "$BACKUP_DIR/filestore_$DATE.tar.gz" -C "$FILESTORE_PATH" .

echo "✅ Backup complete: db_$DATE.dump + filestore_$DATE.tar.gz"

Example 2: Automate with Cron (daily at 2 AM)

# Run: crontab -e
# Add this line:
0 2 * * * /opt/scripts/backup_odoo.sh >> /var/log/odoo_backup.log 2>&1

Example 3: Upload to S3 (after backup)

# Add to backup script after tar command:
aws s3 cp "$BACKUP_DIR/db_$DATE.dump"        s3://my-odoo-backups/db/
aws s3 cp "$BACKUP_DIR/filestore_$DATE.tar.gz" s3://my-odoo-backups/filestore/

# Apply a separate retention policy only after upload verification and a
# successful restore test; do not delete the last known recoverable backup.

Example 4: Full Restore Procedure

set -euo pipefail
umask 077
# Restore into a NEW isolated database and filestore first. Do not drop the
# production database or clear its filestore. Replace these verified paths.
RESTORE_DB="odoo_restore_test"
RESTORE_FILESTORE="/srv/odoo-restore/filestore/$RESTORE_DB"
createdb -U odoo "$RESTORE_DB"  # fails safely if the target already exists
pg_restore --exit-on-error -U odoo -d "$RESTORE_DB" db_YYYYMMDD_HHMMSS.dump
mkdir "$RESTORE_FILESTORE"     # parent must exist; target must be new
# Inspect archive entries first; reject absolute paths and traversal entries.
tar -tzf filestore_YYYYMMDD_HHMMSS.tar.gz
tar -xzf filestore_YYYYMMDD_HHMMSS.tar.gz -C "$RESTORE_FILESTORE"
# Set ownership for the dedicated Odoo service account before startup.
# Start an isolated Odoo instance with this DB and matching data_dir/addons;
# disable outbound email, cron, payments and external integrations.
# Verify login, recent records and attachments. Only plan production cutover
# after this succeeds and the owner approves downtime and rollback.

Best Practices

• ✅ Do: Test restores monthly in a staging environment — a backup you've never restored is not a backup.
• ✅ Do: Follow the 3-2-1 rule: 3 copies, 2 different media types, 1 offsite copy (e.g., S3 or a remote server).
• ✅ Do: Back up immediately before every Odoo upgrade — this is your rollback point.
• ✅ Do: Verify backup integrity: pg_restore --list backup.dump should parse successfully, but only a complete isolated restore and application checks establish recoverability.
• ❌ Don't: Back up only the database without the filestore — all attachments and images will be missing after a restore.
• ❌ Don't: Store backups on the same disk or same server as Odoo — a disk or server failure destroys both.
• ❌ Don't: Run pg_restore --clean against a non-existent database — always create the database first.

Limitations

• Does not cover Odoo.sh built-in backups — Odoo.sh has its own backup system accessible from the dashboard.
• This script assumes a single-database Odoo setup. Multi-database instances require looping over all databases.
• Filestore path may differ between installations (Docker volume vs. bare-metal). Always verify the path with odoo-bin shell before running a restore.
• Large filestores (100GB+) may require incremental backup tools like rsync or restic rather than full tar.gz archives.

Backup archives contain sensitive records and attachments. Encrypt offsite copies, restrict credentials and access, and retain Odoo configuration, custom addons, dependency versions and encryption keys securely alongside the recovery plan. Confirm available space and alert on job failure; a database dump and live filestore archive taken at different states may be inconsistent.