Odoo Module

Complete backup module for Odoo ERP. Backup your PostgreSQL database, filestore attachments, custom addons, and configuration.

Requirements

• Odoo 18.0 or higher
• Python 3.10 or higher
• PostgreSQL 12 or higher
• LOX API key

Installation

1. Download and extract the module

   Extract the module to your Odoo addons directory:

   unzip lox-backup-odoo.zip -d /opt/odoo/addons/

2. Update the addons path

   Ensure the module directory is in your odoo.conf:

   addons_path = /opt/odoo/addons,/opt/odoo/custom-addons

3. Update the apps list

   Go to Apps → Update Apps List in Odoo

4. Install the module

   Search for "LOX Backup" in the Apps menu and click Install.

5. Configure your API key

   Go to Settings → General Settings and scroll down to the LOX Backup section, or navigate to LOX Backup → Configuration → Settings.

Configuration

LOX Backup dashboard in Odoo showing backup status and history

API Settings

LOX Backup settings page in Odoo system settings

Backup Components

Exported Data

The module automatically exports important configuration as JSON:

• Companies - Company information and settings
• Users - User accounts and groups (passwords excluded)
• Installed Modules - List of installed addons with versions
• System Parameters - ir.config_parameter values
• Sequences - Document numbering sequences
• Mail Servers - Outgoing email server configuration

Schedule Options

• Hourly - Run backup every hour (high-traffic systems)
• Twice Daily - Run backup every 12 hours
• Daily - Run backup once per day (recommended)
• Weekly - Run backup once per week
• Disabled - Only manual backups via cron or UI

Scheduled Backups

The module uses Odoo's ir.cron system for scheduled backups. You can also trigger backups via a server cron job:

# Add to your server's crontab (runs daily at 3 AM)
0 3 * * * cd /opt/odoo && ./odoo-bin shell -d mydb -c /etc/odoo.conf --no-http <<< "env['lox.backup'].sudo().run_backup()"

# Or using curl with Odoo's JSON-RPC
0 3 * * * curl -X POST https://your-odoo.com/lox_backup/trigger \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "params": {"token": "YOUR_BACKUP_TOKEN"}}'

Manual Backup

You can trigger a backup in multiple ways:

• Via UI: Go to Settings → LOX Backup → Backup Now
• Via Shell: Use the Odoo shell command
• Via API: Call the JSON-RPC endpoint

Shell Command

# Using odoo-bin shell
cd /opt/odoo
./odoo-bin shell -d your_database -c /etc/odoo.conf --no-http

# In the shell
>>> env['lox.backup'].sudo().run_backup()
>>> env.cr.commit()

Backup Structure

Each backup creates a tar.gz archive with this structure:

odoo-mycompany-20240115_030000.tar.gz
├── database.sql           # Full PostgreSQL dump
├── filestore/             # Attachments and uploads
│   ├── 00/
│   ├── 01/
│   └── ...
├── addons/                # Custom addons (if enabled)
│   ├── my_custom_module/
│   └── ...
└── metadata/
    ├── manifest.json      # Backup metadata
    ├── companies.json
    ├── users.json
    ├── modules.json
    ├── parameters.json
    ├── sequences.json
    └── mail_servers.json

Multi-Database Support

For Odoo installations with multiple databases, the module can be configured per-database or globally:

Restoring from Backup

The module provides an in-app restore wizard with text confirmation for safety:

1. Navigate to backup logs

   Go to Settings → LOX Backup → Backup Logs.

2. Click Restore on the backup

   Click the "Request Restore" button next to any completed backup.

3. Confirm the restoration

   Type RESTORE in the confirmation dialog to proceed. This safety measure prevents accidental data loss.

Manual Restore via CLI

1. Download and extract the backup

   Get the backup from the LOX dashboard and extract the tar.gz file.

   tar -xzf odoo-mycompany-20240115_030000.tar.gz

2. Restore the database

   # Drop existing database (if replacing)
   dropdb your_database
   
   # Create new database
   createdb your_database
   
   # Restore from backup
   psql your_database < database.sql

3. Restore the filestore

   # Copy filestore to Odoo data directory
   cp -r filestore/* ~/.local/share/Odoo/filestore/your_database/
   
   # Or for system-wide installation
   cp -r filestore/* /var/lib/odoo/.local/share/Odoo/filestore/your_database/

4. Restore custom addons (if included)

   cp -r addons/* /opt/odoo/custom-addons/

5. Restart Odoo

   sudo systemctl restart odoo

Odoo.sh Integration

For Odoo.sh hosted instances, you can integrate LOX Backup using a scheduled action:

PULL Mode (New in v18.0.1.3.0)

Enabling PULL Mode

1. Go to LOX Backup settings

   Navigate to Settings → LOX Backup → PULL Configuration.

2. Enable PULL mode

   Toggle "Enable PULL Backups" to generate a secure token.

3. Register instance in LOX dashboard

   Add your Odoo URL and PULL token in the LOX dashboard under CMS Sites.

PULL API Endpoints

POST /lox/pull/backup         # Trigger backup generation
GET  /lox/pull/status         # Get instance status and sizes
GET  /lox/pull/download       # Download generated backup
POST /lox/pull/token/refresh  # Regenerate PULL token

Troubleshooting

Security Considerations

• API Key Storage: The API key is stored encrypted in the database using Odoo'sir.config_parameter system.
• Access Control: Only users in the "LOX Backup / Administrator" group can configure settings and trigger manual backups.
• Database Passwords: User passwords are NOT included in the backup metadata. They remain only in the encrypted database dump.
• Transport Security: All data is transmitted over HTTPS with TLS 1.2+.