Backup & Restore Bash Script Tutorial for Odoo

In this tutorial, we explore bash script backup and restore techniques for Odoo. We focus on writing clear, simple, and modular bash scripts that perform a backup of an Odoo database and then restore it. We will use the keyphrases backup, restore, bash script, and Odoo throughout this tutorial. We include step-by-step explanations, sample code, and practical tips to help you master these processes easily.

Introduction

In this tutorial, we explain how to create and use two separate bash scripts—one for backup and another for restore—in Odoo. We actively build this tutorial by walking through simple code examples, clear instructions, and practical examples. You will quickly understand how to integrate your configuration file, use curl commands, and distribute key parameters evenly in the backup and restore process. Additionally, we discuss important troubleshooting tips and ways to improve your code. Furthermore, we provide helpful links such as the Odoo Documentation for additional insights.

By following these instructions, you will actively use familiar words, transition words, and active voice in every sentence. In addition, you will see the keyphrases appear consistently throughout the text with enough synonyms and variations that maintain readability.

Overview of Backup and Restore Concepts

Before diving into code, let us review fundamental concepts for backup and restore using bash scripts. We start by defining the purposes of backup scripts, explain their significance, and then shift to restore scripts. These scripts work together to ensure data integrity and efficient management of an Odoo database. Moreover, they help you safeguard your data and enable quick recovery. We ensure that each step uses active verbs and clear instructions.

What Is a Backup?

A backup is a process that creates a copy of data so that you can restore it later. In our case, the backup script downloads a snapshot of an Odoo database. We actively use commands like curl to request a backup from an Odoo URL endpoint. Additionally, we store the data in a ZIP file for security and easy transfer. Transitioning to the next section, we also outline how this script reads from a configuration file.

What Is a Restore?

A restore is a process that recovers data from a backup. The restore script in our tutorial uploads a previously created backup file to an Odoo server and uses CURL commands to restore the database. By actively following the steps, you can see the integration of configuration parameters, such as destination URL and master password, clearly outlined in the code and documentation. We then outline the specific parts of the scripts.

Prerequisites

Before you start, ensure you have the following:

• A Linux-based system or a Unix-like environment with bash support.
• Basic knowledge of shell scripting.
• The curl command-line tool.
• The unzip command, especially for the backup script.
• A preconfigured Odoo instance accessible via a URL.

In addition, you should have a configuration file named br.conf based on the example below. We actively encourage you to verify that you have all necessary tools installed.

Configuration File: br.conf

The configuration file is critical as it stores the variables required by both scripts. We maintain the configuration in a format that allows sourcing it directly by bash. The file uses simple key-value pairs, and it looks as follows:

# File: br.conf
src_url="http://localhost:8069"
src_master_passwd="password_backup"
src_db="nama_db_backup"

dest_url="http://localhost:8069"
dest_master_passwd="password_restore"

Let us note the following:

• The src_url points to the Odoo instance from which you will create a backup.
• The src_master_passwd is the master password to authenticate the backup operation.
• The src_db defines the name of the database that you want to back up.
• The dest_url and dest_master_passwd parameters control the restore process and define where the backup file should be restored.
• You can edit this file to suit the specific settings of your Odoo environments.

We actively use transition words to help you understand each component. Next, we discuss the creation of the backup script file.

Creating the Backup Script

We now develop the backup script called backup.sh. This script reads variables from br.conf, then makes a curl POST request to perform the backup. The script saves the backup file as a ZIP file. We use active sentences to explain every step as you code along.

Backup Script Code (backup.sh)

Below is the complete code for the backup script:

#!/bin/bash
# File: backup.sh
# Usage: ./backup.sh nama_backup.zip
#
# This script uses a configuration file and performs the Odoo backup.
# It actively reads parameters from 'br.conf' and uses curl for the backup.

if [ "$#" -ne 1 ]; then
    echo "Usage: $0 nama_backup.zip"
    exit 1
fi

backup_file="$1"
conf_file="br.conf"

if [ ! -f "$conf_file" ]; then
    echo "File konfigurasi $conf_file tidak ditemukan!"
    exit 1
fi

# Source the configuration file to import variables
. "$conf_file"

# Verify that the required variables are set
if [ -z "$src_url" ] || [ -z "$src_master_passwd" ] || [ -z "$src_db" ]; then
    echo "Variabel src_url, src_master_passwd, atau src_db belum terisi di $conf_file"
    exit 1
fi

echo "Memulai backup database $src_db dari $src_url..."
curl -o "$backup_file" -X POST \
     -F "master_pwd=$src_master_passwd" \
     -F "name=$src_db" \
     "$src_url/web/database/backup"

if [ -f "$backup_file" ]; then
    echo "Backup selesai: $backup_file"
else
    echo "Backup gagal."
    exit 1
fi

Code Explanation

We actively parse the command-line arguments to get the backup file name. Then, we source the br.conf configuration file. We use an if statement to ensure that all required variables—src_url, src_master_passwd, and src_db—are defined. After that, the script sends a POST request using curl to the backup endpoint of Odoo. Finally, it checks if the backup file was successfully created.

This backup script uses familiar commands and short sentences. Additionally, we actively guide you through each command, ensuring that you use transitional words like “then” and “after” to improve readability.

Creating the Restore Script

Next, we create the restore script called restore.sh. This script requires two parameters: the backup file name and the destination database name. It uses the br.conf file to obtain the destination URL and master password. It then uploads the backup file to restore the database.

Restore Script Code (restore.sh)

Below is the complete code for the restore script:

#!/bin/bash
# File: restore.sh
# Usage: ./restore.sh nama_backup.zip nama_database_tujuan
#
# This script uses a configuration file and performs the Odoo restore.
# It reads the backup file and restores it to the destination database as defined in the configuration.

if [ "$#" -ne 2 ]; then
    echo "Usage: $0 nama_backup.zip nama_database_tujuan"
    exit 1
fi

backup_file="$1"
dest_db="$2"
conf_file="br.conf"

if [ ! -f "$conf_file" ]; then
    echo "File konfigurasi $conf_file tidak ditemukan!"
    exit 1
fi

# Source the configuration file to import variables
. "$conf_file"

# Verify that the required variables for restore are set
if [ -z "$dest_url" ] || [ -z "$dest_master_passwd" ]; then
    echo "Variabel dest_url atau dest_master_passwd belum terisi di $conf_file"
    exit 1
fi

if [ ! -f "$backup_file" ]; then
    echo "File backup $backup_file tidak ditemukan!"
    exit 1
fi

echo "Memulai proses restore ke database $dest_db di $dest_url..."
curl -F "master_pwd=$dest_master_passwd" \
     -F "backup_file=@$backup_file" \
     -F "name=$dest_db" \
     "$dest_url/web/database/restore"

echo "Restore selesai."

Code Explanation

In the restore script, you first check that the correct number of arguments (backup file and destination database) is provided. Then, similar to the backup script, you source the br.conf file to load necessary variables for the destination configuration. Next, the script uses curl to post the backup file to the Odoo restore endpoint. Finally, it confirms the successful completion of the restore process.

We use transition words such as “then” and “next” to guide you through the process. You actively see how each step transforms inputs into the final outcome.

Detailed Walkthrough and Best Practices

In this section, we provide a detailed walkthrough of both scripts and ensure you have all the essential information to deploy these solutions effectively.

Using the Configuration File

The configuration file (br.conf) is vital for separating static settings from the code logic. By doing so, you can easily update the URLs, passwords, and database names without changing the bash scripts. This practice enhances modularity and improves maintainability. Furthermore, you can share the bash scripts among multiple developers while keeping private credentials in the configuration file.

For example, consider the following br.conf:

# File: br.conf
src_url="http://localhost:8069"
src_master_passwd="password_backup"
src_db="nama_db_backup"

dest_url="http://localhost:8069"
dest_master_passwd="password_restore"

This file must reside in the same directory as your bash scripts because the scripts actively source it. Moreover, always ensure that file permissions secure your configuration, especially if it contains sensitive data.

Examining the Backup Process

When you run the backup process, the script takes a single argument—the name of the backup file. It then reads br.conf, verifies the required variables, and sends a POST request to the backup endpoint of your Odoo instance. You should observe the terminal output that confirms the backup’s success.

The use of the curl command is simple yet powerful. You actively pass form parameters (master_pwd and name) that instruct Odoo on which database to back up. After the backup run, the script checks whether the output file exists. This feedback loop ensures you immediately notice any failures.

Examining the Restore Process

When you initiate the restore process, you provide two arguments: the backup ZIP file and the destination database name. The script then reads the configuration file to retrieve the destination connection details. Once verified, the script sends a form POST using curl, uploading the backup file to your Odoo instance.

By actively monitoring the output, you can quickly identify and fix errors. The script actively uses defensive programming techniques, such as checking file existence and the proper count of arguments. This approach prevents common mistakes and improves overall robustness.

Step-by-Step Run Commands

To ensure a smooth experience, follow these steps:

1. Prepare the configuration file br.conf with your specific parameters.
2. Create the bash script files backup.sh and restore.sh using the code provided.
3. Mark the scripts as executable: chmod +x backup.sh restore.sh
4. Run the backup script. For example: ./backup.sh my_backup.zip
5. After ensuring that the backup file my_backup.zip exists, run the restore script: ./restore.sh my_backup.zip my_restored_db

Each command runs sequentially, and the scripts actively use feedback to let you know when each step has completed. Moreover, by just typing these commands, you incorporate a rapid cycle of testing and deployment.

Error Handling and Troubleshooting

All active steps in both scripts perform error handling. For instance, if any required variable is missing in the configuration file, the script immediately displays an error message and exits. Similarly, if the backup file does not exist or if the number of command-line arguments is incorrect, the scripts promptly inform you what went wrong.

Here are some common errors and their solutions:

• Error: “File konfigurasi br.conf tidak ditemukan!”
  Solution: Ensure that br.conf exists in the same folder as your scripts.
• Error: “Variabel src_url, src_master_passwd, atau src_db belum terisi di br.conf”
  Solution: Open br.conf and verify that all required keys have the correct values.
• Error: “File backup [file_name] tidak ditemukan!”
  Solution: Verify that you have specified the correct backup file name when running the restore process.

Moreover, you can add further diagnostic logging in the scripts if needed. For instance, you may echo the values of your configuration variables (without exposing sensitive data) to verify they are being read correctly.

Enhancements for Production Use

While these scripts are simple and easy to understand, you can enhance them further in real-world production scenarios by considering the following suggestions:

• Logging: Write outputs to a log file so you can review the backup and restore process later.
• Security Enhancements: Secure your configuration file with correct file permissions or use environment variables to store sensitive data.
• Notification: Send notifications (via email or messaging apps) upon completion of backup/restore operations.
• Cron Jobs: Schedule these scripts to run automatically using cron jobs, which helps automate the backup process and ensures regular data backups.

Each enhancement actively improves the robustness of your solution, and you will take more control over your database management processes.

Integration with Odoo Documentation

Odoo provides comprehensive documentation on database management operations. We highly recommend you explore the Odoo Documentation for more details on API methods used by these scripts. By integrating Odoo’s official guidelines, you can build even more advanced backup and restore solutions.

Additional Tips for Effective Scripting

To create effective scripts, keep the following pointers in mind:

• Simplification: Always try to simplify your scripts. Use clear variable names such as backup_file, dest_db, and conf_file.
• Modularization: Split related tasks into functions when the scripts grow in complexity. This style enhances readability, and you can reuse code easily.
• Comments: Comment your code generously. Each major step deserves an explanation to help future maintenance.
• Testing: Test your scripts in a safe environment before running them on production servers. This step avoids accidental data loss.
• Version Control: Use version control systems like Git to manage your script evolution effectively.

By following these best practices, you actively reduce errors and improve the long-term maintainability of your code.

Summary and Final Thoughts

In summary, you now have two distinct bash scripts: one for backup and the other for restore of an Odoo database. We actively walked through each script starting from the configuration file, to the creation of the backup and restore scripts. Each step uses active language, transition words, and ensures simplicity and clarity.

You learned how to:

• Prepare and source configuration files using br.conf.
• Create a backup using curl and validate its success.
• Restore a backup file to a destination Odoo database with proper error handling.
• Enhance the scripts for production use by adding logging, notifications, and security measures.

Using the provided scripts, you actively manage your backups and restores and avoid common pitfalls. The tutorial also shows you practical examples and mirrors industry best practices.

Complete Code Recap

For your convenience, here is all the code in one place.

Configuration File: br.conf

# File: br.conf
src_url="http://localhost:8069"
src_master_passwd="password_backup"
src_db="nama_db_backup"

dest_url="http://localhost:8069"
dest_master_passwd="password_restore"

Backup Script: backup.sh

#!/bin/bash
# File: backup.sh
# Usage: ./backup.sh nama_backup.zip
#
# This script uses a configuration file and performs the Odoo backup.
# It actively reads parameters from 'br.conf' and uses curl for the backup.

if [ "$#" -ne 1 ]; then
    echo "Usage: $0 nama_backup.zip"
    exit 1
fi

backup_file="$1"
conf_file="br.conf"

if [ ! -f "$conf_file" ]; then
    echo "File konfigurasi $conf_file tidak ditemukan!"
    exit 1
fi

# Source the configuration file to import variables
. "$conf_file"

# Verify that the required variables are set
if [ -z "$src_url" ] || [ -z "$src_master_passwd" ] || [ -z "$src_db" ]; then
    echo "Variabel src_url, src_master_passwd, atau src_db belum terisi di $conf_file"
    exit 1
fi

echo "Memulai backup database $src_db dari $src_url..."
curl -o "$backup_file" -X POST \
     -F "master_pwd=$src_master_passwd" \
     -F "name=$src_db" \
     "$src_url/web/database/backup"

if [ -f "$backup_file" ]; then
    echo "Backup selesai: $backup_file"
else
    echo "Backup gagal."
    exit 1
fi

Restore Script: restore.sh

#!/bin/bash
# File: restore.sh
# Usage: ./restore.sh nama_backup.zip nama_database_tujuan
#
# This script uses a configuration file and performs the Odoo restore.
# It reads the backup file and restores it to the destination database as defined in the configuration.

if [ "$#" -ne 2 ]; then
    echo "Usage: $0 nama_backup.zip nama_database_tujuan"
    exit 1
fi

backup_file="$1"
dest_db="$2"
conf_file="br.conf"

if [ ! -f "$conf_file" ]; then
    echo "File konfigurasi $conf_file tidak ditemukan!"
    exit 1
fi

# Source the configuration file to import variables
. "$conf_file"

# Verify that the required variables for restore are set
if [ -z "$dest_url" ] || [ -z "$dest_master_passwd" ]; then
    echo "Variabel dest_url atau dest_master_passwd belum terisi di $conf_file"
    exit 1
fi

if [ ! -f "$backup_file" ]; then
    echo "File backup $backup_file tidak ditemukan!"
    exit 1
fi

echo "Memulai proses restore ke database $dest_db di $dest_url..."
curl -F "master_pwd=$dest_master_passwd" \
     -F "backup_file=@$backup_file" \
     -F "name=$dest_db" \
     "$dest_url/web/database/restore"

echo "Restore selesai."

Conclusion

This tutorial actively demonstrates how to create two simple and effective bash scripts for backup and restore operations in Odoo. You have seen how to use a configuration file, utilize curl commands, and incorporate error handling throughout the scripts. Additionally, by following the best practices and tips provided, you can further enhance your scripts for production use.

By reading and experimenting with this code, you can confidently manage your Odoo databases using a modular, secure, and maintainable method. We hope you find this tutorial useful and encourage you to explore more advanced features in the Odoo Documentation. Enjoy coding and may your backup and restore operations be smooth and error-free!