Comment installer une pile ERPNext sur Ubuntu 20.04

ERPNext est une suite de planification des ressources d’entreprise (ERP) qui tire parti de la puissance et de la flexibilité des technologies open-source. Elle excelle dans la gestion des processus opérationnels de base tels que la finance, les ventes, les ressources humaines, la fabrication, les achats, les services, les besoins du helpdesk, et plus encore. Parmi les avantages de la mise en œuvre d’un système comme ERPNext, on peut citer :

• Une meilleure productivité en automatisant les processus commerciaux répétitifs
• Une amélioration de l’efficacité informatique en partageant une base de données pour tous les départements de la société
• Une meilleure prise de décisions grâce à une vision intégrale de la relation entre les unités commerciales

ERPNext repose sur Frappe, un cadre d’application web full-stack écrit en Python qui tire pleinement parti de l’environnement d’exécution Node/JavaScript et utilise MariaDB comme backend de base de données. L’un des nombreux avantages des applications reposant sur Frappe, comme ERPNext, est l’utilitaire de ligne de commande bench. L’ILC bench permet aux administrateurs de gagner du temps en automatisant des tâches telles que l’installation, la mise à jour, la configuration et la gestion de plusieurs sites Frappe/ERPNext.

Dans ce tutoriel, vous installerez et configurez une pile ERPNext sur un serveur tournant sous Ubuntu 20.04. Cela vous permettra de configurer votre pile pour divers environnements de développement ou de production en fonction de vos besoins, et cela vous préparera à construire une architecture plus complexe et tolérante aux défauts.

• Un serveur Ubuntu 20.04 avec au moins 4 Go de RAM et un utilisateur sudo non root. Vous pouvez configurer votre serveur et votre utilisateur en suivant notre guide de configuration initiale de serveur Ubuntu 20.04.

• Un nom de domaine entièrement enregistré avec un enregistrement A pointant vers votre serveur. Si vous utilisez un droplet DigitalOcean, vous pouvez suivre ce guide pour configurer correctement votre DNS. Ce tutoriel utilisera your_domain.

Bien que la configuration d’un pare-feu pour le développement soit facultative, pour la production il s’agit d’une pratique de sécurité obligatoire.

Vous devrez ouvrir les ports suivants sur votre serveur ERPNext :

• 80/tcp et 443/tcp pour HTTP et HTTPS, respectivement
• 3306/tcp pour la connexion à MariaDB (recommandé uniquement si vous avez besoin d’un accès à la base de données à distance)
• 143/tcp et 25/tcp pour IMAP et STMP, respectivement
• 22/tcp pour SSH (si vous n’avez pas encore activé OpenSSH dans vos paramètres UFW)
• 8000/tcp pour tester votre plate-forme avant de la déployer en production

Pour ouvrir plusieurs ports à la fois, vous pouvez utiliser la commande suivante :

sudo ufw allow 22,25,143,80,443,3306,8000/tcp

Vous pouvez également autoriser des connexions à partir d’adresses IP spécifiques sur des ports spécifiques en utilisant cette commande :

sudo ufw allow from server_IP to any port port_number

Après avoir ouvert tous les ports nécessaires, activez le pare-feu :

sudo ufw enable

Confirmez maintenant l’état de votre pare-feu :

sudo ufw status

UFW fournira une liste des règles que vous avez autorisées. Assurez-vous que les ports nécessaires d’ERPNext sont ouverts :

Output
Status: active

To                         Action      From
--                         ------      ----
22,25,80,143,443,3306,8000/tcp  ALLOW       Anywhere
22,25,80,143,443,3306,8000/tcp (v6) ALLOW       Anywhere (v6)

Pour plus d’informations sur la configuration d’UFW, consultez notre guide Comment configurer un pare-feu avec UFW sur Ubuntu 20.04.

La mise en place d’un pare-feu approprié est la première des deux étapes préliminaires. Vous allez maintenant configurer le mappage du clavier et l’encodage des caractères sur votre serveur.

Il est fortement recommandé de configurer le mappage du clavier pour la console ainsi que la langue et l’encodage des caractères sur votre hôte. Ceci est nécessaire pour éviter les problèmes éventuels lors du processus d’installation d’ERPNext 12. Remarquez que cette configuration n’a rien à voir avec la langue de l’interface utilisateur sur votre plateforme ERPNext actuelle, mais avec la configuration locale du système.

Tout d’abord, mettez à jour votre serveur :

sudo apt update

Configurez maintenant le keymap, la langue et l’encodage des caractères :

sudo localectl set-keymap us && sudo localectl set-locale LANG=en_US.utf8

L’utilitaire localectl est utilisé par Ubuntu 20.04 et d’autres distributions Linux pour contrôler et modifier les paramètres locaux et la disposition du clavier à l’échelle du système, avant que l’utilisateur ne se connecte, ce qui est exactement ce dont ERPNext 12 a besoin.

Vous devrez également ajouter les lignes suivantes à votre fichier /etc/environment. Utilisez nano ou votre éditeur de texte préféré pour ouvrir le fichier :

sudo nano /etc/environment

Maintenant ajoutez le contenu suivant :

LC_ALL=en_US.UTF-8
LC_CTYPE=en_US.UTF-8
LANG=en_US.UTF-8

Enregistrez et fermez le fichier.

Redémarrez votre serveur pour appliquer tous les changements :

sudo reboot

Laissez à votre serveur quelques minutes pour redémarrer, puis utilisez ssh pour réintroduire votre instance. Vous êtes maintenant prêt à installer votre base de données.

Vous allez maintenant ajouter MariaDB à la pile de votre serveur. ERPNext 12 requiert MariaDB 10.2+ pour fonctionner correctement. Comme Ubuntu 20.04 inclut MariaDB 10.3 dans ses référentiels officiels, vous pouvez installer cette version en utilisant la commande apt :

sudo apt install mariadb-server

Si vous préférez une version plus récente de MariaDB, vous pouvez suivre l’Étape 3 de notre guide Comment installer une pile ERPNext sur Ubuntu 18.04. Cela vous guidera à travers l’assistant du référentiel en ligne de MariaDB, qui vous aidera à installer la version la plus récente : MariaDB 10.5.

Après avoir installé mariadb-server, installez les packages suivants :

sudo apt install python3-mysqldb libmysqlclient-dev

ERPNext 12 est une application Python : elle requiert donc la bibliothèque python3-mysqldb pour la gestion de la base de données. libmysqlclient-dev est nécessaire pour accéder à certaines fonctionnalités de développeur MariaDB.

Ensuite, ajoutez une couche de sécurité supplémentaire au serveur MariaDB, en exécutant le script mysql_secure_installation :

sudo mysql_secure_installation

Le script mysql_secure_installation vous posera plusieurs questions :

• La première invite vous demandera le mot de passe root, mais comme aucun de mot de passe n’a été configuré, appuyez sur ENTER.
• Ensuite, lorsqu’il vous sera demandé de modifier le mot de passe root de MariaDB, répondez N. L’utilisation du mot de passe par défaut avec l’authentification Unix est la configuration recommandée pour les systèmes basés sur Ubuntu, car le compte root est étroitement lié aux tâches de maintenance automatisées du système.
• Les questions restantes concernent la suppression de l’utilisateur anonyme de la base de données, la restriction du compte root pour vous connecter à distance sur localhost, la suppression de la base de données de test et le rechargement des tables de privilèges. Vous pouvez répondre Y à toutes ces questions en toute sécurité.

Après avoir terminé le script mysql_secure_installation, MariaDB commencera à fonctionner en utilisant sa configuration par défaut. L’installation standard ERPNext utilise le root user de MariaDB, pour toutes les opérations de la base de données. Bien que cette approche soit pratique sur les configurations de serveur unique, elle n’est pas considérée comme une bonne pratique en matière de sécurité. Par conséquent, dans la section suivante, vous apprendrez à éviter ce problème en créant un nouvel utilisateur avec des privilèges spéciaux.

sudo mysql

CREATE DATABASE sammy;

SHOW DATABASES;

Output
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| sammy              |
+--------------------+

GRANT ALL PRIVILEGES ON *.* TO 'sammy'@'%' IDENTIFIED BY 'mariadb_password' WITH GRANT OPTION;

SELECT host, user, Super_priv FROM mysql.user;

Output
+-----------+-------+------------+
| Host      | User  | Super_priv |
+-----------+-------+------------+
| localhost | root  | Y          |
| localhost | mysql | Y          |
| %         | sammy| Y         |
+-----------+-------+------------+
3 rows in set (0.001 sec)

FLUSH PRIVILEGES;

exit

Une fois MariaDB installé et sécurisé, il est temps de le mettre au point pour les connexions ERPNext.

Tout d’abord, arrêtez mariadb.service :

sudo systemctl stop mariadb

Utilisez maintenant nano ou votre éditeur de texte préféré pour créer un fichier de configuration MariaDB appelé mariadb.cnf :

sudo nano /etc/mysql/mariadb.conf.d/mariadb.cnf

Ensuite, ajoutez le modèle de configuration officiel d’ERPNext :

[mysqld]

# GENERAL #
user                           = mysql
default-storage-engine         = InnoDB
socket                         = /var/lib/mysql/mysql.sock
pid-file                       = /var/lib/mysql/mysql.pid

# MyISAM #
key-buffer-size                = 32M
myisam-recover                 = FORCE,BACKUP

# SAFETY #
max-allowed-packet             = 256M
max-connect-errors             = 1000000
innodb                         = FORCE

# DATA STORAGE #
datadir                        = /var/lib/mysql/

# BINARY LOGGING #
log-bin                        = /var/lib/mysql/mysql-bin
expire-logs-days               = 14
sync-binlog                    = 1

# REPLICATION #
server-id                      = 1

# CACHES AND LIMITS #
tmp-table-size                 = 32M
max-heap-table-size            = 32M
query-cache-type               = 0
query-cache-size               = 0
max-connections                = 500
thread-cache-size              = 50
open-files-limit               = 65535
table-definition-cache         = 4096
table-open-cache               = 10240

# INNODB #
innodb-flush-method            = O_DIRECT
innodb-log-files-in-group      = 2
innodb-log-file-size           = 512M
innodb-flush-log-at-trx-commit = 1
innodb-file-per-table          = 1
innodb-buffer-pool-size        = 5462M
innodb-file-format             = barracuda
innodb-large-prefix            = 1
collation-server               = utf8mb4_unicode_ci
character-set-server           = utf8mb4
character-set-client-handshake = FALSE
max_allowed_packet             = 256M

# LOGGING #
log-error                      = /var/lib/mysql/mysql-error.log
log-queries-not-using-indexes  = 0
slow-query-log                 = 1
slow-query-log-file            = /var/lib/mysql/mysql-slow.log

# CONNECTIONS #

pid-file        = /var/run/mysqld/mysqld.pid
socket          = /var/run/mysqld/mysqld.sock
bind-address    = 0.0.0.0

[mysql]
default-character-set = utf8mb4

[mysqldump]
max_allowed_packet=256M

Enregistrez et fermez le fichier. Pour obtenir des informations plus détaillées sur ces configurations, consultez ce fichier modèle sur le référentiel Github d’ERPNext. C’est un point de départ utile pour explorer ces options.

Le fichier de configuration,/etc/mysql/mariadb.conf.d/mariadb.cnf, complète et remplace également quelques valeurs incluses dans la configuration par défaut de MariaDB située dans /etc/mysql/my.cnf. Ce fichier vous donne un modèle de conservation qui améliore considérablement les performances de la base de données pour ERPNext. N’oubliez pas toutefois que si ce modèle est un excellent point de départ, rien ne vous empêche d’améliorer encore plus les performances de MariaDB en ajustant ces paramètres à vos besoins.

sudo systemctl start mariadb

mysql --user sammy --password mariadb_password --host=localhost --protocol=tcp --port=3306 test

Output
mysql  Ver 15.1 Distrib 10.4.13-MariaDB, for debian-linux-gnu (x86_64) using readline 5.2
Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Usage: mysql [OPTIONS] [database]

Default options are read from the following files in the given order:
/etc/my.cnf /etc/mysql/my.cnf ~/.my.cnf

...

  --ssl-verify-server-cert
                      Verify server's "Common Name" in its cert against
                      hostname used when connecting. This option is disabled by
                      default.
  -t, --table         Output in table format.
  --tee=name          Append everything into outfile. See interactive help (\h)
                      also. Does not work in batch mode. Disable with
                      --disable-tee. This option is disabled by default.
  -u, --user=name     User for login if not current user.
  -U, --safe-updates  Only allow UPDATE and DELETE that uses keys.
  -U, --i-am-a-dummy  Synonym for option --safe-updates, -U.
  -v, --verbose       Write more. (-v -v -v gives the table output format).

...

max-join-size                     1000000
secure-auth                       FALSE
show-warnings                     FALSE
plugin-dir                        (No default value)
default-auth                      (No default value)
binary-mode                       FALSE
connect-expired-password          FALSE

sudo systemctl restart mariadb

sudo systemctl enable mariadb

Maintenant que le backend de votre base de données est prêt, vous pouvez continuer à configurer votre application web ERPNext. Dans cette section, vous apprendrez à installer et configurer tous les composants requis par ERPNext 12, puis à installer l’application elle-même.

Commencez par préparer le serveur avec tous les paquets système requis par ERPNext 12. Installez les dépendances dans tout le système en utilisant la commande suivante :

sudo DEBIAN_FRONTEND=noninteractive apt install -y curl build-essential python3-testresources python3-setuptools python3-dev libffi-dev python3-pip libcurl4 dnsmasq fontconfig git htop libcrypto++-dev libfreetype6-dev liblcms2-dev libwebp-dev libxext6 libxrender1 libxslt1-dev libxslt1.1 libffi-dev ntpdate postfix python3-dev python-tk screen vim xfonts-75dpi xfonts-base zlib1g-dev apt-transport-https libsasl2-dev libldap2-dev libcups2-dev pv libjpeg8-dev libtiff5-dev tcl8.6-dev tk8.6-dev libdate-manip-perl logwatch

La variable DEBIAN_FRONTEND=noninteractive a été transmise à la commande d’installation afin d’éviter les invites Postfix. Pour obtenir des informations détaillées sur la configuration de Postfix, lisez notre guide Comment installer et configurer Postfix sur Ubuntu 20.04

Ensuite, mettez à jour pip3, qui est le gestionnaire de paquets standard de Python, puis installez les dernières versions de trois modules Python supplémentaires :

 sudo -H python3 -m pip install --upgrade setuptools cryptography psutil

setuptools facilite l’installation et la mise à jour des paquets Python, cryptography ajoute des capacités de cryptage à votre pile et psutil aide à la surveillance du système. Maintenant que vous avez installé toutes les dépendances générales nécessaires, vous allez installer tous les services et les bibliothèques nécessaires à ERPNext 12.

curl -sL https://deb.nodesource.com/setup_12.x -o nodesource_setup.sh

sudo nano nodesurce_setup.sh

sudo bash nodesource_setup.sh

sudo apt install nodejs

sudo npm install -g yarn

cd /tmp

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 cp /usr/local/bin/wkhtmlto* /usr/bin/

sudo chmod a+x /usr/bin/wk*

sudo apt install redis-server

sudo systemctl enable redis-server

Maintenant que vous avez mis en place toutes les exigences de pile d’ERPNext, vous pouvez exploiter la flexibilité de l’utilitaire de ligne de commande bench de Frappe. L’ILC bench a été conçue dans le but d’aider les utilisateurs dans le processus d’installation, de mise en place et de gestion d’applications comme ERPNext, qui reposent sur le Framework Frappe. Dans les sections suivantes, vous allez installer l’ILC bench et l’utiliser ensuite pour terminer le processus de configuration d’ERPNext 12.

Assurez-vous que l’utilisateur de Frappe (dans ce cas sammy) dispose des droits appropriés sur son répertoire home :

sudo chown sammy -R /home/sammy

Maintenant, clonez le référentiel frappe/bench vers votre répertoire de base. N’oubliez pas de remplacer sammy par votre nom d’utilisateur système :

git clone https://github.com/frappe/bench /home/sammy/.bench --depth 1 --branch master

Installez l’ILC bench :

sudo pip3 install -e /home/sammy/.bench

Ce guide suppose que vous installez ERPNext 12 pour des scénarios de test/production et que vous utilisez donc la branche master. Mais si votre intention est de développer des applications ou des modules ERPNext personnalisés, la branche develop pourrait être préférable. Dans les deux cas, vous êtes maintenant prêt à installer le Framework de Frappe. Ce sera la dernière étape avant d’installer ERPNext lui-même.

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

bench init /home/sammy/frappe-bench --frappe-path https://github.com/frappe/frappe --frappe-branch version-12 --python python3

Output
...
Done in 82.23s.
INFO:bench.utils:setting up backups
no crontab for sammy
SUCCESS: Bench /home/sammy/frappe-bench initialized

Dans cette section, vous allez configurer un site reposant sur Frappe, puis installer l’application ERPNext 12 sur celui-ci.

Passez dans le répertoire où Frappe a été initialisé.

cd /home/sammy/frappe-bench

Avant de continuer, vous devrez installer des versions spécifiques des bibliothèques Python numpy et pandas dans l’environnement virtuel de Frappe. Installez ces paquets en utilisant la commande suivante :

./env/bin/pip install numpy==1.18.5 && ./env/bin/pip install pandas==0.24.2

À ce stade, l’installation pourrait s’arrêter pendant environ 10 à 20 minutes tout en affichant ce message :

Output
...
Building wheel for pandas (setup.py) ... -

Cela est dû à un bug lié à pandas et Ubuntu 20.04, qui, au moment où nous écrivons ces lignes, est encore assez récent. Néanmoins les paquets s’installeront, et une fois que cela sera terminé, vous verrez un résultat comme celui-ci :

Output
...
Successfully built pandas
Installing collected packages: pandas
Successfully installed pandas-0.24.2

Vous pouvez maintenant continuer l’installation. Téléchargez ERPNext 12 depuis son référentiel en utilisant l’ILC bench :

bench get-app erpnext https://github.com/frappe/erpnext --branch version-12

Ensuite, créez le nouveau site, en remplaçant your_domain par le domaine que vous avez associé à l’IP de ce serveur :

bench new-site your_domain --admin-password 'erpnext_admin_password' --mariadb-root-username sammy --mariadb-root-password 'mariadb_password'

Prenons un moment pour examiner les options utilisées dans la commande ci-dessus :

• bench new-site crée un nouveau site reposant sur le framework Frappe.
• your_domain est le nom du nouveau site. Assurez-vous que le DNS de votre domaine a un enregistrement A pointant vers l’IP de votre serveur.
• erpnext_admin_passwordest le mot de passe souhaité pour l’utilisateur Administrator d’ERPNext. Conservez ce mot de passe dans un endroit sûr, vous en aurez besoin sous peu.
• mariadb_password est le mot de passe que vous avez créé au début du guide de l’utilisateur sammy de MariaDB.

Ensuite, installez l’application ERPNext sur le site :

bench --site your_domain install-app erpnext

Une fois l’installation terminée, vous disposerez d’une application ERPNext 12 fonctionnelle. Maintenant, testons-la à l’aide d’une commande bench :

bench start

La commande ci-dessus lancera une console de surveillance en temps réel vous montrant divers messages concernant le serveur web et d’autres services. Ouvrez un navigateur web et naviguez vers localhost:8000 (pour les installations locales) ou your_domain:8000 (si vous utilisez un serveur distant). Vous verrez l’écran de connexion ERPNext (nous procéderons à la connexion et à la configuration dans une étape ultérieure, une fois que notre site sera prêt pour la production).

Après avoir consulté votre déploiement de test, retournez à votre terminal et appuyez sur CTRL+C. Cela arrêtera ERPNext et permettra de quitter la console de surveillance.

Si votre objectif principal est de créer des modules ou de modifier ERPNext 12, vous pouvez alors vous arrêter à ce stade. Aucun autre composant n’est nécessaire pour le développement. Cependant, si vous avez besoin d’un système prêt pour la production qui ne requiert pas d’initialisation manuelle, vous devrez alors installer et configurer quelques composants supplémentaires. C’est votre prochaine étape.

Bien que votre application ERPNext 12 soit prête, le système dans son ensemble n’est pas encore prêt pour la production. Pour garantir la fiabilité et la sécurité d’ERPNext, vous devrez activer quelques services supplémentaires :

• Fail2ban fournit une couche supplémentaire de protection contre les tentatives de recours abusif des utilisateurs et des bots malveillants.
• Nginx fonctionne principalement comme un proxy web, redirigeant tout le trafic depuis le port 8000 vers le port 80 (HTTP) ou le port 443 (HTTPS)
• Supervisor veille à ce que les processus clés d’ERPNext soient constamment opérationnels, en les redémarrant au besoin.

Jusqu’à ce stade, vous avez installé et configuré manuellement ERPNext 12, ce qui vous a permis de personnaliser le processus pour qu’il corresponde à n’importe quel cas d’utilisation particulier. Néanmoins, pour le reste de la configuration de la production, vous pouvez tirer parti de la commodité de l’ILC bench, afin d’automatiser l’installation et la configuration de ces services restants.

Assurez-vous que vous êtes bien dans le répertoire de travail de Frappe :

cd /home/sammy/frappe-bench

Maintenant, utilisez la commande suivante pour terminer la configuration d’ERPNext 12 pour la production :

sudo bench setup production sammy --yes

La commande ci-dessus installera et configurera aNginx, Supervisor, et Fail2Ban, et définira sammy comme propriétaire de l’environnement de production.

Les fichiers de configuration créés par la commande bench  sont les suivants :

• Deux fichiers de configuration Nginx situés dans /etc/nginx/nginx.conf et /etc/nginx/conf.d/frappe-bench.conf
• Un proxy jail Fail2Ban situé dans /etc/fail2ban/jail.d/nginx-proxy.conf et un filtre situé dans /etc/fail2ban/filter.d/nginx-proxy.conf

Ces configurations par défaut suffiront pour ce tutoriel, mais n’hésitez pas à explorer et ajuster ces fichiers pour qu’ils correspondent à vos besoins. Vous pouvez arrêter tous les services en exécutant :

sudo supervisorctl stop all

Et ensuite, une fois que vous êtes prêt, vous pouvez redémarrer vos services :

sudo supervisorctl start all

Maintenant vous êtes prêt pour tester votre installation.

systemctl list-unit-files | grep 'fail2ban\|nginx\|supervisor'

Output
fail2ban.service                       enabled
nginx.service                          enabled
supervisor.service                     enabled

Maintenant que vous avez correctement installé votre application ERPNext 12, vous pouvez commencer à mettre en œuvre le système pour vos besoins commerciaux. Un bon point de départ consiste à cliquer sur le bouton Getting Started sur le tableau de bord d’ERPNext. ERPNext vous aidera alors à configurer la plate-forme pour tous vos besoins commerciaux et de commerce électronique.

Vous pouvez également souhaiter améliorer la vitesse d’ERPNext. Si c’est le cas, vous pouvez lire les informations sur le réglage de performance ERPNext, qui vous guideront sur les meilleures pratiques et sur la manière de résoudre les problèmes liés aux performances.