erplibre/README.base.md

ERPLibre

ERPLibre is a CRM/ERP platform including automated installation, maintenance, and development of open source modules of the Odoo community version. It is a "soft-fork" of the Odoo Community Edition (OCE), meaning it aims at contributing back upstream. It is based on a set of production-ready modules, supported by the Odoo Community Association (OCA) and an ecosystem of specialized companies. This solution ensures digital sovereignty in a local environment while integrating pre-trained Generative Transformers (GPT), bringing an additional dimension to data management and automation.

ERPLibre est une plateforme CRM/ERP incluant l'installation, la maintenance et le développement automatisés de modules open source de la version communautaire d'Odoo. C'est un "soft-fork" de l'Odoo Community Edition (OCE), ce qui signifie qu'il vise à contribuer en amont. Il est basé sur un ensemble de modules prêts pour la production, supportés par l'Odoo Community Association (OCA) et un écosystème d'entreprises spécialisées. Cette solution assure la souveraineté numérique dans un environnement local tout en intégrant des Transformers Génératifs Pré-entraînés (GPT), apportant une dimension supplémentaire à la gestion des données et à l'automatisation.

Follow us on Mastodon : https://fosstodon.org/@erplibre

Suivez-nous sur Mastodon : https://fosstodon.org/@erplibre

Features

• Multi-version Odoo support : run Odoo 12.0, 13.0, 14.0, 15.0, 16.0, 17.0 and 18.0 in the same workspace, with independent Python virtual environments (.venv.erplibre and .venv.odooXX)
• Interactive CLI (TODO.py) : guided interactive tool for installation, execution, database management, code formatting, mobile compilation, and more. Launch it with make
• Code generator : generate Odoo modules automatically with support for views, portal, snippets, inheritance, i18n, and JavaScript
• Selenium automation : web testing and automation with Selenium Grid, video recording, and login automation
• Mobile application : ERPLibre Home Mobile (Owl + Capacitor), compiled and deployed via TODO.py
• Docker deployment : production-ready Docker images with PostgreSQL 18 and PostGIS
• Deployment tools : Nginx, Apache, Cloudflare DDNS, Certbot SSL, systemd services
• Database tools : backup, restore, clone, migration between versions, production-to-dev migration
• Performance tools : request-per-second measurement, parallel test execution, coverage analysis

Fonctionnalités

• Support multi-version Odoo : exécutez Odoo 12.0, 13.0, 14.0, 15.0, 16.0, 17.0 et 18.0 dans le même espace de travail, avec des environnements virtuels Python indépendants (.venv.erplibre et .venv.odooXX)
• CLI interactif (TODO.py) : outil interactif guidé pour l'installation, l'exécution, la gestion de bases de données, le formatage de code, la compilation mobile, et plus encore. Lancez-le avec make
• Générateur de code : générez des modules Odoo automatiquement avec support des vues, portail, snippets, héritage, i18n et JavaScript
• Automatisation Selenium : tests web et automatisation avec Selenium Grid, enregistrement vidéo et automatisation de connexion
• Application mobile : ERPLibre Home Mobile (Owl + Capacitor), compilée et déployée via TODO.py
• Déploiement Docker : images Docker prêtes pour la production avec PostgreSQL 18 et PostGIS
• Outils de déploiement : Nginx, Apache, Cloudflare DDNS, Certbot SSL, services systemd
• Outils de base de données : sauvegarde, restauration, clonage, migration entre versions, migration production vers développement
• Outils de performance : mesure de requêtes par seconde, exécution de tests en parallèle, analyse de couverture

Supported Odoo versions

Versions Odoo supportées

Odoo version	Python	Status
18.0	3.12.10	Active
17.0	3.10.18	Inactive
16.0	3.10.18	Inactive
15.0	3.8.20	Deprecated
14.0	3.8.20	Deprecated
13.0	3.7.17	Deprecated
12.0	3.7.17	Deprecated

Switch between versions with make switch_odoo_18, make switch_odoo_16, etc.

The Python in that table is the one of the Odoo virtual environment. The tooling virtual environment .venv.erplibre (TODO, repo, formatters) runs its own interpreter, 3.14.7, set by conf/python-erplibre-version. Where a distribution does not carry it, pyenv compiles it.

Changez de version avec make switch_odoo_18, make switch_odoo_16, etc.

Le Python de ce tableau est celui de l'environnement virtuel Odoo. L'environnement virtuel d'outillage .venv.erplibre (TODO, repo, formateurs) tourne sur son propre interpréteur, 3.14.7, fixé par conf/python-erplibre-version. Là où une distribution ne le porte pas, pyenv le compile.

Supported platforms

• Ubuntu : 24.04, 25.10, 26.04 — 20.04 and 22.04 are dropped, pikepdf requiring a qpdf 12.2 built in C++20
• Linux Mint : 22.3
• Debian : 12 (bookworm) and 13 (trixie)
• Fedora : 41 and later
• AlmaLinux, Rocky Linux : 9 and 10 — RHEL and CentOS Stream take the same path
• openSUSE : Leap 16.0 and Tumbleweed
• Arch Linux : rolling release
• NixOS : 25.11 — the dependencies are DECLARED in conf/nixos/erplibre.nix and applied by nixos-rebuild, where the four other families install them one command at a time
• macOS : through mise or pyenv
• Windows : through WSL or Docker
• Architectures : amd64, arm64 and s390x (IBM Z mainframe)

Plateformes supportées

• Ubuntu : 24.04, 25.10, 26.04 — 20.04 et 22.04 sont retirées, pikepdf réclamant un qpdf 12.2 bâti en C++20
• Linux Mint : 22.3
• Debian : 12 (bookworm) et 13 (trixie)
• Fedora : 41 et suivantes
• AlmaLinux, Rocky Linux : 9 et 10 — RHEL et CentOS Stream empruntent le même chemin
• openSUSE : Leap 16.0 et Tumbleweed
• Arch Linux : rolling release
• NixOS : 25.11 — les dépendances y sont DÉCLARÉES dans conf/nixos/erplibre.nix puis appliquées par nixos-rebuild, là où les quatre autres familles les installent commande par commande
• macOS : par mise ou pyenv
• Windows : par WSL ou Docker
• Architectures : amd64, arm64 et s390x (mainframe IBM Z)

Installation in production

Easy installation on Ubuntu or Debian using Docker

This has been tested in Debian 12 and Ubuntu 24.04 LTS.

Note : This is meant for a test environment, on a local network or similar environment not directly exposed to the Internet.

Installation en production

Installation facile sur Ubuntu ou Debian avec Docker

Ceci a été testé sur Debian 12 et Ubuntu 24.04 LTS.

Note : Ceci est prévu pour un environnement de test, sur un réseau local ou un environnement similaire non exposé directement à Internet.

1. Make sure Docker and nginx web server are installed:
   sudo apt install docker.io docker-compose-v2 nginx

2. Get the latest ERPLibre Docker compose file:
   wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/master/docker-compose.yml

3. Install and run ERPLibre with Docker running as a daemon (web server):
   sudo docker compose up -d

4. Open the final installation step at this web page :
   http://[server IP]:8069/web/database/manager
   

5. Finish the installation by providing a database name, email and password. then click on Create Database. Depending on your system resources this may take more than 2 minutes without feedback ! Check your browser loading indicator.

6. Next, the web page will reload itself, and you should see the Applications list in ERPLibre:
   

   You can now personalize your ERPLibre installation.

1. Assurez-vous que Docker et le serveur web nginx sont installés :
   sudo apt install docker.io docker-compose-v2 nginx

2. Obtenez le dernier fichier Docker compose d'ERPLibre :
   wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/master/docker-compose.yml

3. Installez et lancez ERPLibre avec Docker en mode daemon (serveur web) :
   ``sudo docker compose up -d`

4. Ouvrez l'étape finale d'installation à cette page web :
   http://[server IP]:8069/web/database/manager
   

5. Terminez l'installation en fournissant un nom de base de données, un courriel et un mot de passe, puis cliquez sur Create Database. Selon les ressources de votre système, cela peut prendre plus de 2 minutes sans retour visuel ! Vérifiez l'indicateur de chargement de votre navigateur.

6. Ensuite, la page web se rechargera automatiquement et vous devriez voir la liste des applications dans ERPLibre :
   

   Vous pouvez maintenant personnaliser votre installation ERPLibre.

For more information, read Docker guide.

Install from source code

Automated installation

Pour plus d'informations, consultez le guide Docker.

Installation depuis le code source

Installation automatisée

For Debian/Ubuntu

Pour Debian/Ubuntu

sudo apt install make python3

Clone the project:

Clonez le projet :

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

Follow the instruction on the following script, it will try to detect your environment.

Suivez les instructions du script suivant, il essaiera de détecter votre environnement.

make

make and ./install.sh start TODO through the interpreter that can read it: .venv.erplibre when it carries the right version, otherwise the system python3 when it is recent enough, otherwise the install itself — a system older than conf/python-erplibre-version cannot parse the code, so it goes straight to the install rather than stopping on a syntax error. When the environment is missing but the system Python suffices, TODO offers to run ./script/install/install_erplibre.sh (in a terminal) or prints that command. The install builds the environment through EL_PYTHON_PROVIDER (mise or pyenv); an existing .venv.erplibre on another Python version is DELETED and rebuilt, and whatever was installed in it by hand goes with it.

make et ./install.sh lancent TODO par l'interpréteur capable de le lire : .venv.erplibre quand il porte la bonne version, sinon le python3 du système s'il est assez récent, sinon l'installation elle-même — un système plus ancien que conf/python-erplibre-version ne sait pas analyser le code, donc on va droit à l'installation plutôt que de s'arrêter sur une erreur de syntaxe. Quand l'environnement manque mais que le Python du système suffit, TODO propose de lancer ./script/install/install_erplibre.sh (dans un terminal) ou affiche cette commande. L'installation bâtit l'environnement par EL_PYTHON_PROVIDER (mise ou pyenv) ; un .venv.erplibre existant sur une autre version de Python est SUPPRIMÉ puis rebâti, et ce qu'on y avait posé à la main part avec lui.

Manually

Into Ubuntu, minimal dependency:

Manuellement

Sous Ubuntu, dépendance minimale :

sudo apt install make git curl

Into Ubuntu, developer dependency:

Sous Ubuntu, dépendance développeur :

sudo apt install make build-essential libssl-dev zlib1g-dev libreadline-dev libsqlite3-dev curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev liblzma-dev libbz2-dev libldap2-dev libsasl2-dev

Clone the project:

Clonez le projet :

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

make install_os detects the distribution and picks the right dependency script: apt for Ubuntu, Linux Mint and Debian, dnf for Fedora and the RHEL family, zypper for openSUSE, pacman for Arch, and a declarative module for NixOS. See the supported platforms above.

make install_os détecte la distribution et choisit le bon script de dépendances : apt pour Ubuntu, Linux Mint et Debian, dnf pour Fedora et la famille RHEL, zypper pour openSUSE, pacman pour Arch, et un module déclaratif pour NixOS. Voir les plateformes supportées ci-dessus.

make install_os
make install_odoo_18

Install a specific Odoo version:

Installez une version spécifique d'Odoo :

make install_odoo_16
make install_odoo_17
make install_odoo_18

Update your configuration if you need to run from another interface than 127.0.0.1, file config.conf

Mettez à jour votre configuration si vous devez exécuter depuis une autre interface que 127.0.0.1, fichier config.conf

xmlrpc_interface = 0.0.0.0

Show version :

Afficher la version :

make version

Ready to execute:

Prêt à exécuter :

make run

Test

Execute ERPLibre test with his code generator.

Test

Exécutez les tests ERPLibre avec son générateur de code.

time make test_full_fast

Documentation

Guide	Description
DISCOVER	Learn and explore ERPLibre
DEVELOPMENT	Development environment setup
PRODUCTION	Production server deployment
RUN	Execution modes and use cases
CODE_GENERATOR	Odoo module code generation
MIGRATION	Database migration between versions
GIT_REPO	Git repository management
POETRY	Python dependency management
FAQ	Frequently asked questions
HOWTO	How-to guides
WINDOWS_INSTALLATION	Windows installation

Documentation

Guide	Description
DISCOVER	Découvrir et explorer ERPLibre
DEVELOPMENT	Configuration de l'environnement de développement
PRODUCTION	Déploiement du serveur de production
RUN	Modes d'exécution et cas d'utilisation
CODE_GENERATOR	Génération de code de modules Odoo
MIGRATION	Migration de base de données entre versions
GIT_REPO	Gestion des dépôts Git
POETRY	Gestion des dépendances Python
FAQ	Foire aux questions
HOWTO	Guides pratiques
WINDOWS_INSTALLATION	Installation sous Windows

Contributing

See CONTRIBUTION.md for guidelines.

Contribution

Consultez CONTRIBUTION.md pour les directives.

License

This project is licensed under the GNU Affero General Public License v3.0.

Licence

Ce projet est sous licence GNU Affero General Public License v3.0.