erplibre/doc/WINDOWS_INSTALLATION.base.md

Windows 10 version 2004 and up or 11 - release and development

A guide on how to set up a workspace and run ERPLibre on Windows 10 version 2004 and up or Windows 11. There are two methods of installation, one is automatic and the other manual.

"WSL2 Ubuntu 22.04" will be referred as "WSL2"

"PyCharm Professional" will be referred as "PyCharm"

Install WSL2

Run Powershell with administrator rights and run the following command:

Windows 10 version 2004 et plus ou 11 - publication et developpement

Un guide pour configurer un espace de travail et executer ERPLibre sur Windows 10 version 2004 et plus ou Windows 11. Il existe deux methodes d'installation, une automatique et l'autre manuelle.

"WSL2 Ubuntu 22.04" sera designe par "WSL2"

"PyCharm Professional" sera designe par "PyCharm"

Installer WSL2

Executez Powershell avec les droits administrateur et lancez la commande suivante :

wsl --install -d Ubuntu-22.04

If you have trouble opening the Powershell with administrator rights, press Windows + R, enter the following line and press OK. You will be automatically prompted for administrator rights.

Si vous avez des difficultes a ouvrir Powershell avec les droits administrateur, appuyez sur Windows + R, entrez la ligne suivante et appuyez sur OK. Les droits administrateur vous seront automatiquement demandes.

powershell.exe

Troubleshooting - Optional

If you have issues enable virtualization options in BIOS is available (hyper-v, vt-x, etc). Search for Turn Windows features on or off in the Windows search bar and ensure that Windows Subsystem for Linux is turned on before restarting your machine.

You can also try theses powershell commands:

Depannage - Optionnel

Si vous rencontrez des problemes, activez les options de virtualisation dans le BIOS si disponibles (hyper-v, vt-x, etc). Recherchez Activer ou desactiver des fonctionnalites Windows dans la barre de recherche Windows et assurez-vous que Sous-systeme Windows pour Linux est active avant de redemarrer votre machine.

Vous pouvez aussi essayer ces commandes powershell :

dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
wsl --set-default-version 2

Download and install the lastest Linux kernel update package from Microsoft with the following link:

Telechargez et installez le dernier package de mise a jour du noyau Linux de Microsoft avec le lien suivant :

https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi

Only run this command as your last resort as it can break other virtual machines:

N'executez cette commande qu'en dernier recours car elle peut casser d'autres machines virtuelles :

bcdedit /set hypervisorlaunchtype auto

Other Installation methods for WSL2

Run Powershell with administrator rights and run the following command:

Autres methodes d'installation pour WSL2

Executez Powershell avec les droits administrateur et lancez la commande suivante :

curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004

Run Powershell with administrator rights and run the following commands:

Executez Powershell avec les droits administrateur et lancez les commandes suivantes :

Invoke-WebRequest -Uri https://aka.ms/wslubuntu2004 -OutFile Ubuntu.appx -UseBasicParsing
Add-AppxPackage .\Ubuntu.appx

Install WSL2 from the Microsoft Store with the following link:

Installez WSL2 depuis le Microsoft Store avec le lien suivant :

https://apps.microsoft.com/store/detail/ubuntu-22041-lts/9PN20MSR04DW

Setup WSL2 for ERPLibre

Once WSL2 has been installed correctly, reboot your computer.

You can open your Ubuntu many ways:

• Search "Ubuntu" by clicking the Windows key
• Download the Windows Terminal from the Microsoft Store

If you are using the Windows Terminal, you just have to click the little arrow next to the + sign and then you will see Ubuntu.

Configurer WSL2 pour ERPLibre

Une fois WSL2 installe correctement, redemarrez votre ordinateur.

Vous pouvez ouvrir votre Ubuntu de plusieurs facons :

• Recherchez "Ubuntu" en cliquant sur la touche Windows
• Telechargez le Terminal Windows depuis le Microsoft Store

Si vous utilisez le Terminal Windows, vous n'avez qu'a cliquer sur la petite fleche a cote du signe + et vous verrez Ubuntu.

Setup a GUI for you Ubuntu

1. Update your Ubuntu

Configurer une interface graphique pour votre Ubuntu

1. Mettre a jour votre Ubuntu

sudo apt-get update -y && sudo apt-get upgrade -y

2. Install the XFCE4 Desktop

2. Installer le bureau XFCE4

sudo apt install -y xrdp xfce4 xfce4-goodies

3. Setup the Desktop

3. Configurer le bureau

sudo cp /etc/xrdp/xrdp.ini /etc/xrdp/xrdp.ini.bak
sudo sed -i 's/3389/3390/g' /etc/xrdp/xrdp.ini
sudo sed -i 's/max_bpp=32/#max_bpp=32\nmax_bpp=128/g' /etc/xrdp/xrdp.ini
sudo sed -i 's/xserverbpp=24/#xserverbpp=24\nxserverbpp=128/g' /etc/xrdp/xrdp.ini
echo xfce4-session > ~/.xsession

4. Setup the Remote Desktop Connection

4. Configurer la connexion Bureau a distance

sudo nano /etc/xrdp/startwm.sh

Comment these lines with a #

Commentez ces lignes avec un #

test -x /etc/X11/Xsession && exec /etc/X11/Xsession
exec /bin/sh /etc/X11/Xsession

Add this line at the end of the file

Ajoutez cette ligne a la fin du fichier

startxfce4

Exit with Ctrl+S, Ctrl+X

5. Starting Ubuntu Desktop GUI

Open Ubuntu Terminal on your Windows and enter this command

Quittez avec Ctrl+S, Ctrl+X

5. Demarrer l'interface graphique du bureau Ubuntu

Ouvrez le terminal Ubuntu sur votre Windows et entrez cette commande

sudo /etc/init.d/xrdp start

Then open Remote Desktop Connection by clicking the Windows key and connect to localhost:3390

Memory - Optional

If WSL is taking too much memory, you can reduce with an easy step. You just have to go to C:\Users\YourUsername.wslconfig and create a .wslconfig file and write:

Ensuite ouvrez Connexion Bureau a distance en cliquant sur la touche Windows et connectez-vous a localhost:3390

Memoire - Optionnel

Si WSL utilise trop de memoire, vous pouvez la reduire avec une etape simple. Il suffit d'aller dans C:\Users\VotreNomUtilisateur.wslconfig et de creer un fichier .wslconfig et d'ecrire :

sudo /etc/init.d/xrdp start

[wsl2]
memory=3GB

Installation of the necessary and up-to-date tools

Installation des outils necessaires et a jour

sudo apt update
sudo apt install build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libsqlite3-dev libreadline-dev libffi-dev curl libbz2-dev rsync make git

Installation of ERPLibre under WSL2

Make sure to be in the directory where you want to clone the project.

Installation d'ERPLibre sous WSL2

Assurez-vous d'etre dans le repertoire ou vous souhaitez cloner le projet.

git clone https://github.com/ERPLibre/ERPLibre.git
cd ERPLibre
make install

Add role to PostgresSQL, change USERNAME field in the command with your UNIX username from your WSL2 environment.

Ajoutez un role a PostgreSQL, changez le champ USERNAME dans la commande avec votre nom d'utilisateur UNIX de votre environnement WSL2.

sudo service postgresql start
sudo su - postgres -c "createuser -s USERNAME" 2>/dev/null || true

Common Problems During Installation

Error During make install

Ensure all dependencies are installed correctly. Re-run the following command to fix any broken dependencies:

Problemes courants lors de l'installation

Erreur lors de make install

Assurez-vous que toutes les dependances sont installees correctement. Relancez la commande suivante pour corriger les dependances cassees :

sudo apt-get install -f

PostgreSQL Not Starting

Check the PostgreSQL service status with the following command:

PostgreSQL ne demarre pas

Verifiez le statut du service PostgreSQL avec la commande suivante :

sudo service postgresql status

If PostgreSQL is not running, try restarting it with:

Si PostgreSQL ne fonctionne pas, essayez de le redemarrer avec :

sudo service postgresql restart

Running ERPLibre

Everytime you restart your machine, the following command has to be executed to start the PostgreSQL service if it is not already running:

Executer ERPLibre

A chaque redemarrage de votre machine, la commande suivante doit etre executee pour demarrer le service PostgreSQL s'il n'est pas deja en cours d'execution :

sudo service postgresql start

After that run this command in the root of the project:

Ensuite lancez cette commande a la racine du projet :

./run.sh

Verifying ERPLibre

While ERPLibre is running, make sure that you can connect to the following URL http://localhost:8069 and have the ability to create, modify and remove databases.

Set up Development Environment - PyCharm

Install PyCharm

Install PyCharm from the following link:

Verification d'ERPLibre

Pendant qu'ERPLibre est en cours d'execution, assurez-vous que vous pouvez vous connecter a l'URL suivante http://localhost:8069 et que vous avez la possibilite de creer, modifier et supprimer des bases de donnees.

Configurer l'environnement de developpement - PyCharm

Installer PyCharm

Installez PyCharm depuis le lien suivant :

https://www.jetbrains.com/pycharm/download/#section=windows

Set up Pycharm

Select Connect to WSL under Remote Development. After that select your Ubuntu instace ("Ubuntu-22.04"). Point Project directory to the root of the project. Once everything has been selected and filled out correctly, click on Start IDE and Connect.

Configurer Pycharm

Selectionnez Connect to WSL sous Remote Development. Ensuite selectionnez votre instance Ubuntu ("Ubuntu-22.04"). Pointez Project directory vers la racine du projet. Une fois que tout a ete selectionne et rempli correctement, cliquez sur Start IDE and Connect.

Press CTRL+ALT+S, search for interpreter and inside the Python Interpreter page, click on Add Interpreter and select Add Local Interpreter....

Appuyez sur CTRL+ALT+S, recherchez interpreter et dans la page Python Interpreter, cliquez sur Add Interpreter et selectionnez Add Local Interpreter....

Make sure to select Virtualenv Environment on the left and the Existing radio button. Once theses are both selected properly, point your interpreter to the ../ERPLibre/.venv/bin/python directory of the project and click on OK.

Assurez-vous de selectionner Virtualenv Environment a gauche et le bouton radio Existing. Une fois les deux correctement selectionnes, pointez votre interpreteur vers le repertoire ../ERPLibre/.venv/bin/python du projet et cliquez sur OK.

If these last steps to set up your development environment were unsuccessful, follow the next "Manual" steps to set up your environment.

Manual Installation

Install Python 3.10.14

You can delete the files that are left over in your home directory regarding the python installation when the steps have been completed succesfully.

Si ces dernieres etapes pour configurer votre environnement de developpement n'ont pas fonctionne, suivez les etapes "Manuelles" suivantes pour configurer votre environnement.

Installation manuelle

Installer Python 3.10.14

Vous pouvez supprimer les fichiers restants dans votre repertoire personnel concernant l'installation de Python une fois les etapes completees avec succes.

cd ~
wget https://www.python.org/ftp/python/3.10.14/Python-3.10.14.tgz
tar -xzf Python-3.10.14.tgz
cd Python-3.10.14
./configure --enable-optimizations
make -j $(nproc)
sudo make install

Verify the installation

Verifier l'installation

python3.10

Set Python 3.10.14 as default

Definir Python 3.10.14 par defaut

alias python='/usr/local/bin/python3.10'
source ~/.bashrc

Set up Pycharm

Open the project directory in PyCharm.

Press CTRL+ALT+S, search for interpreter and inside the Python Interpreter page, click on Add Interpreter and select On WSL....

Configurer Pycharm

Ouvrez le repertoire du projet dans PyCharm.

Appuyez sur CTRL+ALT+S, recherchez interpreter et dans la page Python Interpreter, cliquez sur Add Interpreter et selectionnez On WSL....

Wait until PyCharm detects your WSL2 instance and press NEXT. Click on System Interpreter on the left, select the correct interpreter if it hasn't done so automatically and click Create.

Attendez que PyCharm detecte votre instance WSL2 et appuyez sur NEXT. Cliquez sur System Interpreter a gauche, selectionnez le bon interpreteur s'il ne l'a pas fait automatiquement et cliquez sur Create.

Close the project's settings. Once PyCharm prompts you to import modules and allow it.

Common problems with Windows Development

Broken Terminal

Search for terminal in the settings, and under Application Settings in the Shell path: field enter the following line:

Fermez les parametres du projet. Lorsque PyCharm vous propose d'importer des modules, autorisez-le.

Problemes courants avec le developpement Windows

Terminal casse

Recherchez terminal dans les parametres, et sous Application Settings dans le champ Shell path: entrez la ligne suivante :

wsl.exe

High Memory Usage warnings

If you experience high memory usage, click on Help in the toolbar and choose Change Memory Settings to increase the memory heap of the IDE.

Missing or incorrect imported modules

PyCharm might not fully recognize some details from requirements.txt and pyproject.toml (e.g., specific module versions). If you encounter issues at runtime or while debugging, search for the correct version of the module and reinstall it using PyCharm's package manager.

Can't run ERPLibre from PyCharm

If ERPLibre fails to run from PyCharm, execute the following command in the root directory of the project from the terminal in PyCharm or WSL2:

Avertissements d'utilisation elevee de la memoire

Si vous constatez une utilisation elevee de la memoire, cliquez sur Help dans la barre d'outils et choisissez Change Memory Settings pour augmenter la memoire allouee a l'IDE.

Modules importes manquants ou incorrects

PyCharm peut ne pas reconnaitre completement certains details de requirements.txt et pyproject.toml (par exemple, des versions specifiques de modules). Si vous rencontrez des problemes a l'execution ou lors du debogage, recherchez la bonne version du module et reinstallez-le avec le gestionnaire de paquets de PyCharm.

Impossible d'executer ERPLibre depuis PyCharm

Si ERPLibre ne se lance pas depuis PyCharm, executez la commande suivante dans le repertoire racine du projet depuis le terminal de PyCharm ou WSL2 :

./script/ide/pycharm_configuration.py

Can't restart ERPLibre

Run htop from the terminal in PyCharm or WSL2 and close the python processes related to ERPLibre to release the socket.

References

WSL Installation Comprehensive guide on installing Windows Subsystem for Linux (WSL) on Windows.

PostgreSQL Official Documentation Official PostgreSQL documentation for troubleshooting common issues and learning more about PostgreSQL commands and configuration.

PyCharm Installation and Configuration Quick start guide for setting up and configuring PyCharm, including handling Python modules and environment setup.

WSL Troubleshooting Troubleshooting guide for common issues encountered in WSL, providing solutions for various problems that may arise.

Linux GUI Instructions for setting up a graphical user interface (GUI) in WSL, which might be helpful for better integration of Linux applications.

Memory Problem Guide on how to manage and limit memory usage in WSL 2 to avoid high memory consumption issues.

Impossible de redemarrer ERPLibre

Lancez htop depuis le terminal de PyCharm ou WSL2 et fermez les processus Python lies a ERPLibre pour liberer le socket.

References

Installation de WSL Guide complet sur l'installation du Sous-systeme Windows pour Linux (WSL) sur Windows.

Documentation officielle de PostgreSQL Documentation officielle de PostgreSQL pour le depannage des problemes courants et pour en apprendre davantage sur les commandes et la configuration de PostgreSQL.

Installation et configuration de PyCharm Guide de demarrage rapide pour la configuration de PyCharm, incluant la gestion des modules Python et la configuration de l'environnement.

Depannage de WSL Guide de depannage pour les problemes courants rencontres avec WSL, fournissant des solutions pour divers problemes qui peuvent survenir.

Interface graphique Linux Instructions pour configurer une interface graphique (GUI) dans WSL, ce qui peut etre utile pour une meilleure integration des applications Linux.

Probleme de memoire Guide sur la gestion et la limitation de l'utilisation de la memoire dans WSL 2 pour eviter les problemes de consommation elevee de memoire.