📘Developer Install of OpenG2P Package on Linux

Installation of Social Registry on developer machine

The guide provides steps to install the OpenG2P package on a laptop/desktop running on Linux system. Developers can run the entire OpenG2P package on their machines.

Prerequisites

Below are the prerequisites to install the OpenG2P package on a laptop/desktop.

Operating System/Server	Linux System
Language	Python3
Repository	GitHub
Database	PostgreSQL
Platform	Odoo 15.0 Odoo 17.0

Odoo 15.0

Installation of Odoo 15.0

1. Update system packages

• Log in to your Linux server using SSH and update the package list and upgrade the existing packages.

sudo apt update
sudo apt upgrade -y

2. Install dependencies

• Odoo requires several dependencies to function correctly. Install them using the following commands.

sudo apt install -y python3-pip python3-dev build-essential libxml2-dev libxslt1-dev libevent-dev libsasl2-dev libldap2-dev libpq-dev libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev libopenjp2-7-dev libtiff5-dev libffi-dev nodejs npm

3. Create Odoo user

• It is recommended to create a separate system user to run Odoo for security purposes. Create the user with the following command.

  sudo adduser --system --home=/opt/odoo --group odoo

4. Install and configure PostgreSQL

• Install PostgreSQL server and create a new database user for Odoo.

  sudo apt install -y postgresql
  sudo su - postgres
  createuser --createdb --username postgres --no-createrole --no-superuser --pwprompt odoo_user
  exit

5. Install Wkhtmltopdf.

• Odoo supports printing report files in PDF format. Wkhtmltopdf helps to generate reports in PDF format from HTML data format. Moreover, the report engine converts Qweb template reports to HTML format and Wkhtmltopdf will produce reports in PDF format.

  sudo wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.bionic_amd64.deb
  sudo dpkg -i wkhtmltox_0.12.5-1.bionic_amd64.deb
  sudo apt install -f

6. Install Odoo.

• Clone the odoo15 repository from the official GitHub repository.

  sudo git clone https://github.com/odoo/odoo.git -b 15.0 /opt/odoo/odoo15

Cloning the odoo15 repository takes time because of the large file.

• Create a new Python virtual environment for Odoo using Python 3.11

  cd /opt/odoo
  python3.11 -m venv odoo-venv
• Turn on the virtual environment.

  source odoo-venv/bin/activate
• Switch to the odoo15 directory and install the required Python libraries:

  sudo chown -R <odoo_user>: /opt/odoo/odoo15
  cd /opt/odoo/odoo15
  pip3 install wheel
  pip3 install -r requirements.txt

7. Configure Odoo.

• Edit the configuration file /opt/odoo/odoo15/debian/odoo.conf and set the appropriate values for the following parameters:

sudo nano /opt/odoo/odoo15/debian/odoo.conf

[options]
addons_path = /opt/odoo/odoo15/addons,/opt/odoo/odoo15/custom-addons
admin_passwd = strong_admin_password
db_host = localhost
db_port = 5432
db_user = odoo_user
db_password = your_database_password

• Inside the customs addons directories, place the relevant project module and custom third-party modules.

8. Start Odoo.

• Start the Odoo server using the following command:

  cd /opt/odoo/odoo15
  ./odoo-bin -c debian/odoo.conf

Odoo 17.0

Installation of Odoo 17.0

1. Update system packages

• Log in to your Linux server using SSH and update the package list and upgrade the existing packages.

sudo apt update
sudo apt upgrade -y

2. Install dependencies.

• Odoo requires several dependencies to function correctly. Install them using the following commands:

sudo apt-get install -y python3-pip
sudo apt-get install python-dev 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
sudo apt-get install -y npm
sudo ln -s /usr/bin/nodejs /usr/bin/node
sudo npm install -g less less-plugin-clean-css
sudo apt-get install -y node-less

3. Create Odoo user.

• It is recommended to create a separate system user to run Odoo for security purposes. Create the user with the following command:

  sudo adduser --system --home=/opt/odoo --group odoo

4. Install and configure PostgreSQL.

• Install PostgreSQL server and create a new database user for Odoo:

  sudo apt install -y postgresql
  sudo su - postgres
  createuser --createdb --username postgres --no-createrole --no-superuser --pwprompt odoo_user
  exit

5. Install Wkhtmltopdf.

• Odoo supports printing report files in PDF format. Wkhtmltopdf helps to generate reports in PDF format from HTML data format. Moreover, the report engine converts the Qweb template reports to HTML format by the report engine and Wkhtmltopdf will produce the report in PDF format.

  sudo wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.bionic_amd64.deb
  sudo dpkg -i wkhtmltox_0.12.5-1.bionic_amd64.deb
  sudo apt install -f

6. Install Odoo.

• Clone the odoo17 repository from the official GitHub repository:

  sudo git clone https://github.com/odoo/odoo.git -b 17.0 /opt/odoo/odoo17

Cloning the odoo17 repository takes time because of the large file.

• Create a new Python virtual environment for Odoo using Python 3.11

  cd /opt/odoo
  python3.11 -m venv odoo17-venv
• Turn on the virtual environment.

  source odoo17-venv/bin/activate
• Switch to the odoo17 directory and install the required Python libraries.

  sudo chown -R <odoo_user>: /opt/odoo/odoo17
  cd /opt/odoo/odoo17
  pip3 install wheel
  pip3 install -r requirements.txt

7. Configure Odoo.

• Edit the configuration file /opt/odoo/odoo17/debian/odoo.conf and set the appropriate values for the following parameters:

sudo nano /opt/odoo/odoo17/debian/odoo.conf

[options]
addons_path = /opt/odoo/odoo17/addons,/opt/odoo/odoo17/custom-addons
admin_passwd = strong_admin_password
db_host = localhost
db_port = 5432
db_user = odoo_user
db_password = your_database_password

• Inside the customs addons directories, place the relevant project module and custom third-party modules.

8. Start Odoo.

• Start the Odoo server using the following command:

  cd /opt/odoo/odoo17
  ./odoo-bin -c debian/odoo.conf

Installation of OpenG2P package

1. Create a custom-addons folder inside the odoo folder to keep all the extra modules.

2. Clone all the OpenG2P modules.

   git clone <repo_url>
3. Install the required Python libraries for all the custom-addons.

   cd /opt/odoo/custom-addons/<module_directory>
   pip3 install -r requirements.txt
4. Add addons directory path to the odoo.conf file in addons_path parameter, mentioned in point 7.
5. For the Social Registry to function properly, your add-ons should include the packages listed below.https://github.com/OpenG2P/openg2p-packaging/blob/main/packaging/packages/social-registry/17.0-develop.txt