Skip to content

feat: Add Odoo installation script for Debian/Ubuntu #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 16.0
Choose a base branch
from
Open

feat: Add Odoo installation script for Debian/Ubuntu #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5c1dc2
feat: Add Odoo installation script for Debian/Ubuntu
google-labs-jules[bot] May 23, 2025
ed846df
Adding MD instructions for installation
google-labs-jules[bot] May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions ODOO_INSTALL_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Odoo Installation Guide using installer.sh

## Introduction

This guide provides step-by-step instructions on how to use the `installer.sh` script to automate the installation of Odoo on a Debian-based Linux system. The script handles system updates, dependency installation, PostgreSQL setup, Odoo source code download, Python environment configuration, wkhtmltopdf installation, and Odoo service setup.

## Prerequisites

Before you begin, ensure you have the following:

* A server running a Debian-based Linux distribution (e.g., Ubuntu 18.04 LTS, Ubuntu 20.04 LTS, Ubuntu 22.04 LTS).
* **Note:** The `wkhtmltopdf` version (0.12.5) included in the script is known to work well with Ubuntu 18.04 (Bionic). For other Ubuntu versions or Debian distributions, if you encounter issues with PDF generation, you might need to find and install a `wkhtmltopdf` package compatible with `libssl1.1` or a version of `wkhtmltopdf` suitable for your specific OS.
* `sudo` or root access on the server.
* Basic familiarity with the Linux command line.
* Internet access on the server to download packages and the Odoo source code.

## Steps to Install Odoo

Follow these steps to install Odoo using the provided script:

1. **Download the script:**

Open your terminal and use `wget` to download the `installer.sh` script from the repository.

```bash
wget https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_REPOSITORY/YOUR_BRANCH/installer.sh -O installer.sh
```

**Note:** Replace `YOUR_USERNAME`, `YOUR_REPOSITORY`, and `YOUR_BRANCH` with the actual username, repository name, and branch where the `installer.sh` script is located.

2. **Make the script executable:**

Once downloaded, you need to give the script execute permissions.

```bash
chmod +x installer.sh
```

3. **Run the script:**

Execute the script using `sudo`. This is necessary because the script will install system packages, create a system user for Odoo, and set up a system service.

```bash
sudo ./installer.sh
```

The script will display its progress as it executes each step. This process might take some time depending on your server's performance and internet speed.

## Post-Installation

After the script finishes, Odoo should be installed and running.

1. **Verify Odoo service:**

You can check the status of the Odoo service to ensure it's active and running:

```bash
sudo systemctl status odoo18.service
```

Look for an "active (running)" status. If there are issues, the output of this command or the log file (see below) can help diagnose them.

2. **Accessing Odoo:**

Open your web browser and navigate to `http://<your_server_ip>:8069`, replacing `<your_server_ip>` with the actual IP address or domain name of your server.

You should see the Odoo database creation page or login page.

## Important Notes

* **Default Passwords:**
* The script sets a default **master admin password** for Odoo to `admin`. This is used to create, manage, and restore databases from the Odoo interface.
* The PostgreSQL user `odoo18` is created with the password `123456`.
* **It is STRONGLY recommended to change both of these passwords immediately in a production environment.** The Odoo master password can be changed in the Odoo configuration file. The PostgreSQL user password should be changed using `psql` and then updated in the Odoo configuration file.

* **Odoo Configuration File:**
* The main Odoo configuration file is located at `/etc/odoo18.conf`. You can modify this file to change settings like passwords, database connection details, addons paths, etc.

* **Log File:**
* Odoo application logs are written to `/var/log/odoo/odoo18.log`. Check this file for errors or detailed operational messages.

* **Odoo Source Code:**
* The Odoo source code is downloaded to `/opt/odoo18`.
* The Python virtual environment for Odoo is located at `/opt/odoo18/venv`.

* **Customization:**
* The script installs Odoo from the `master` branch by default, which typically corresponds to the latest development version. If you need a specific Odoo version (e.g., 16.0, 17.0), you would need to modify the `git clone` command in the `installer.sh` script to specify the desired branch (e.g., `--branch 17.0`).
* The script uses specific versions for dependencies like `wkhtmltopdf` (0.12.5). If you are installing a different Odoo version or on a significantly different OS environment, these dependencies might need to be adjusted. Always refer to the Odoo documentation for the specific version you intend to install.

## Troubleshooting

* **`wkhtmltopdf` issues:**
* If PDF reports are not generated correctly or you see errors related to `wkhtmltopdf`, ensure `libssl1.1` is installed and compatible with your OS version. The version of `libssl1.1` provided by the script is for Ubuntu 18.04/20.04. For newer systems (like Ubuntu 22.04+ which use `libssl3`), you might need to find an alternative `wkhtmltopdf` package (e.g., version 0.12.6 or higher compiled against `libssl3`) or install `libssl1.1` from older repositories if safe and possible.
* Alternatively, consider using a `wkhtmltopdf` package specifically built for your distribution if the one in the script fails.

* **Odoo service not starting:**
* If the `odoo18.service` fails to start, first check its status with `sudo systemctl status odoo18.service` and `journalctl -xeu odoo18.service` for more detailed error messages.
* Examine the Odoo log file at `/var/log/odoo/odoo18.log` for application-specific errors. Common issues include incorrect database credentials in `/etc/odoo18.conf`, port conflicts, or problems with Python dependencies.
* Ensure the paths in `/etc/systemd/system/odoo18.service` (especially `ExecStart`) and `/etc/odoo18.conf` (e.g., `addons_path`, `logfile`) are correct and the `odoo18` user has the necessary permissions.

This guide should help you get Odoo up and running using the automation script. Remember to secure your installation by changing default passwords.
198 changes: 198 additions & 0 deletions installer.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
#!/bin/bash

# Odoo Installation Script for Debian/Ubuntu
#
# This script automates the installation of Odoo on a Debian/Ubuntu based system.
#
# To run this script:
# 1. Download it: wget <raw_github_link_to_this_script> -O install_odoo.sh
# 2. Make it executable: chmod +x install_odoo.sh
# 3. Run it: ./install_odoo.sh
#
# IMPORTANT: Review this script before running it on your system.
# Some commands require sudo privileges and will modify your system.
# It is recommended to run this script on a fresh Debian/Ubuntu installation.

# Exit immediately if a command exits with a non-zero status.
set -e

echo "Starting Odoo installation script..."

# Step 1: Update and Upgrade System Packages
echo "Step 1: Updating and upgrading system packages..."
sudo apt-get update
sudo apt-get upgrade -y
echo "System packages updated and upgraded successfully."

# Step 2: Install Essential Dependencies
echo "Step 2: Installing essential dependencies..."
sudo apt-get install -y python3-pip
sudo apt-get install -y python3-dev libxml2-dev libxslt1-dev zlib1g-dev libsasl2-dev libldap2-dev build-essential libssl-dev libffi-dev libmysqlclient-dev libjpeg-dev libpq-dev libjpeg8-dev liblcms2-dev libblas-dev libatlas-base-dev

# Create a symbolic link for nodejs if it doesn't exist
if [ ! -f /usr/bin/node ]; then
echo "Creating symbolic link for nodejs..."
sudo ln -s /usr/bin/nodejs /usr/bin/node
fi

sudo npm install -g less less-plugin-clean-css
sudo apt-get install -y node-less
echo "Essential dependencies installed successfully."

# Step 3: Install and Configure PostgreSQL
echo "Step 3: Installing and configuring PostgreSQL..."
sudo apt-get install -y postgresql

echo "Creating PostgreSQL user for Odoo..."
sudo su - postgres -c "createuser --createdb --username postgres --no-createrole --superuser odoo18"

# IMPORTANT: This script uses a default password '123456' for the PostgreSQL user 'odoo18'.
# It is STRONGLY recommended to change this password for security reasons.
# You will also need to update the 'db_password' in the Odoo configuration file (/etc/odoo18.conf) if you change it.
echo "Setting password for PostgreSQL user 'odoo18'. You might be prompted by PostgreSQL."
echo "Using default password '123456'. Please change this in a production environment."
sudo su - postgres -c "psql -c \"ALTER USER odoo18 WITH PASSWORD '123456';\""
echo "PostgreSQL installed and configured successfully."

# Step 4: Create Odoo System User
echo "Step 4: Creating Odoo system user..."
sudo adduser --system --home=/opt/odoo18 --group odoo18
echo "Odoo system user created successfully."

# Step 5: Download Odoo Source Code
echo "Step 5: Downloading Odoo source code..."
sudo apt-get install -y git
echo "Cloning Odoo repository (this may take some time)..."
# Create the directory /opt/odoo18 if it doesn't exist and set ownership
sudo mkdir -p /opt/odoo18
sudo chown odoo18:odoo18 /opt/odoo18
sudo su - odoo18 -s /bin/bash -c "git clone https://www.github.com/odoo/odoo --depth 1 --branch master --single-branch /opt/odoo18"
echo "Odoo source code downloaded successfully."

# Step 6: Set Up Python Virtual Environment
echo "Step 6: Setting up Python virtual environment..."
sudo apt-get install -y python3-venv
sudo python3 -m venv /opt/odoo18/venv
echo "Python virtual environment created. Installing Python dependencies..."
sudo /opt/odoo18/venv/bin/pip install -r /opt/odoo18/requirements.txt
echo "Python dependencies installed successfully."

# Step 7: Install wkhtmltopdf
echo "Step 7: Installing wkhtmltopdf..."
# Download libssl1.1 - necessary for wkhtmltopdf 0.12.5 on newer Ubuntu versions
echo "Downloading libssl1.1..."
sudo wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb -P /tmp/
echo "Installing libssl1.1..."
sudo dpkg -i /tmp/libssl1.1_1.1.1f-1ubuntu2_amd64.deb

echo "Downloading wkhtmltopdf..."
sudo wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.bionic_amd64.deb -P /tmp/
echo "Installing xfonts-75dpi..."
sudo apt-get install -y xfonts-75dpi
echo "Installing wkhtmltopdf..."
sudo dpkg -i /tmp/wkhtmltox_0.12.5-1.bionic_amd64.deb

echo "Fixing any potential dependency issues..."
sudo apt-get install -f -y

echo "Cleaning up downloaded .deb files..."
sudo rm /tmp/*.deb
echo "wkhtmltopdf installed successfully."

# Step 8: Configure Odoo
echo "Step 8: Configuring Odoo..."
sudo cp /opt/odoo18/debian/odoo.conf /etc/odoo18.conf

echo "Modifying Odoo configuration file (/etc/odoo18.conf)..."
sudo sed -i "s/^admin_passwd = .*/admin_passwd = admin/" /etc/odoo18.conf
# Ensure db_host, db_port, db_user, db_password are set or add them if not present
sudo sed -i "/^db_host = .*/c\db_host = localhost" /etc/odoo18.conf
sudo sed -i "/^db_port = .*/c\db_port = 5432" /etc/odoo18.conf
sudo sed -i "/^db_user = .*/c\db_user = odoo18" /etc/odoo18.conf
# IMPORTANT: The password '123456' below MUST match the password set for the PostgreSQL user 'odoo18'.
# If you changed the PostgreSQL password, update it here as well.
sudo sed -i "/^db_password = .*/c\db_password = 123456" /etc/odoo18.conf
# Add addons_path if it doesn't exist, or replace it
if grep -q "^addons_path =" /etc/odoo18.conf; then
sudo sed -i "s|^addons_path = .*|addons_path = /opt/odoo18/addons,/opt/odoo18/odoo/addons|" /etc/odoo18.conf
else
echo "addons_path = /opt/odoo18/addons,/opt/odoo18/odoo/addons" | sudo tee -a /etc/odoo18.conf
fi
# Add logfile if it doesn't exist, or replace it
if grep -q "^logfile =" /etc/odoo18.conf; then
sudo sed -i "s|^logfile = .*|logfile = /var/log/odoo/odoo18.log|" /etc/odoo18.conf
else
echo "logfile = /var/log/odoo/odoo18.log" | sudo tee -a /etc/odoo18.conf
fi
# Add default_productivity_apps if it doesn't exist, or replace it
if grep -q "^default_productivity_apps =" /etc/odoo18.conf; then
sudo sed -i "s/^default_productivity_apps = .*/default_productivity_apps = True/" /etc/odoo18.conf
else
echo "default_productivity_apps = True" | sudo tee -a /etc/odoo18.conf
fi

echo "Setting ownership and permissions for Odoo configuration file..."
sudo chown odoo18: /etc/odoo18.conf
sudo chmod 640 /etc/odoo18.conf
echo "Odoo configured successfully."

# Step 9: Set Up Logging
echo "Step 9: Setting up logging..."
sudo mkdir -p /var/log/odoo
sudo chown odoo18:root /var/log/odoo
echo "Logging setup successfully."

# Step 10: Create Systemd Service File
echo "Step 10: Creating Systemd service file..."
sudo tee /etc/systemd/system/odoo18.service <<EOF
[Unit]
Description=Odoo18
Documentation=http://www.odoo.com
Requires=postgresql.service
After=network.target postgresql.service

[Service]
Type=simple
User=odoo18
Group=odoo18
ExecStart=/opt/odoo18/venv/bin/python3 /opt/odoo18/odoo-bin -c /etc/odoo18.conf
StandardOutput=journal+console
StandardError=journal+console
SyslogIdentifier=odoo18

[Install]
WantedBy=multi-user.target
EOF

echo "Setting permissions and ownership for Systemd service file..."
sudo chmod 755 /etc/systemd/system/odoo18.service
sudo chown root: /etc/systemd/system/odoo18.service
echo "Systemd service file created successfully."

# Step 11: Enable and Start Odoo Service
echo "Step 11: Enabling and starting Odoo service..."
sudo systemctl daemon-reload
sudo systemctl enable odoo18.service
sudo systemctl start odoo18.service
echo "Odoo service enabled and started."

echo "Checking Odoo service status (optional)..."
sudo systemctl status odoo18.service

echo "----------------------------------------------------------------"
echo "Odoo installation script finished!"
echo " "
echo "Odoo should now be running."
echo "You can check its status with: sudo systemctl status odoo18.service"
echo "Access Odoo via your web browser: http://<your_server_ip>:8069"
echo " "
echo "Default Odoo admin password (master password for managing databases): admin"
echo "Default PostgreSQL user 'odoo18' password: '123456' (Change this!)"
echo "Odoo configuration file: /etc/odoo18.conf"
echo "Odoo log file: /var/log/odoo/odoo18.log"
echo "Odoo addons path: /opt/odoo18/addons, /opt/odoo18/odoo/addons"
echo "Odoo source code: /opt/odoo18"
echo "Odoo Python virtual environment: /opt/odoo18/venv"
echo "----------------------------------------------------------------"

exit 0