Documentation Frappe Framework

Frappe Framework

Installation

Procédure d’installation de Frappe Framework sur macOS, Debian et Ubuntu : prérequis système, versions des dépendances, installation de nvm, uv et de la CLI bench.

4 min de lectureMis à jour le Source : docs.frappe.io

Configuration requise

Ce guide suppose que vous travaillez sur un ordinateur personnel, un VPS ou un serveur dédié (bare-metal). Vous devez utiliser un système de type *nix : toutes les distributions Linux et macOS sont donc possibles. Si vous êtes sous Windows, vous pouvez utiliser Ubuntu dans WSL.

Seules les distributions suivantes sont officiellement prises en charge :

  1. macOS
  2. Debian / Ubuntu

À retenir

Pour comprendre les composants de la pile technique, consultez la page Architecture.

Prérequis

Versions requises des dépendances selon la version de Frappe :

DépendanceFrappe v14/v15Frappe v16/develop
MariaDB10.6.6+11.8
Python3.10+3.14
NodeJS18+24
Redis / valkey66+
Yarn1.12+1.22+
pip20+25.3+

S’y ajoutent :

  • wkhtmltopdf : version 0.12.6 avec Qt patché, pour la génération de PDF ;
  • cron : pour les tâches planifiées de bench (renouvellement automatique des certificats, sauvegardes planifiées).

macOS

Installez la version en ligne de commande des outils Xcode :

terminal
xcode-select --install

Installez Homebrew, qui simplifie l’installation de paquets sur macOS :

terminal
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

À la fin, l’installateur peut vous demander d’exécuter quelques commandes supplémentaires pour que brew soit disponible dans votre PATH.

Installez wkhtmltopdf :

terminal
curl -L https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-2/wkhtmltox-0.12.6-2.macos-cocoa.pkg -O

installer -pkg wkhtmltox-0.12.6-2.macos-cocoa.pkg -target ~

Vous pouvez ensuite installer les paquets nécessaires avec la commande suivante :

terminal
brew install git redis [email protected] pkg-config mariadb-connector-c

Si vous prévoyez d’utiliser PostgreSQL à la place de MariaDB, ajoutez postgresql à cette liste.

Pendant l’installation, le mot de passe root MySQL vous sera demandé. Si ce n’est pas le cas, vous devrez initialiser vous-même la configuration du serveur MySQL avec la commande :

terminal
sudo mariadb-secure-installation

Attention

N’exécutez cette commande que si le mot de passe ne vous a pas été demandé pendant l’installation.

Passez ensuite à la section « Dépendances communes » ci-dessous.

Debian / Ubuntu

Vous devez utiliser Debian 13+ ou Ubuntu 24.04+ ; avec des versions plus anciennes, certains paquets peuvent poser problème.

Mettez à jour l’index des paquets de votre système :

terminal
sudo apt update

Installez git, redis et mariadb :

terminal
sudo apt install git redis-server libmariadb-dev mariadb-server mariadb-client pkg-config

Pendant l’installation, le mot de passe root MySQL vous sera demandé. Si ce n’est pas le cas, vous devrez initialiser vous-même la configuration du serveur MySQL avec la commande :

terminal
sudo mariadb-secure-installation

Attention

N’exécutez cette commande que si le mot de passe ne vous a pas été demandé pendant l’installation.

Il est très important de retenir ce mot de passe : il vous servira plus tard.

Installer wkhtmltopdf

terminal
sudo apt install xvfb libfontconfig

Téléchargez le paquet wkhtmltopdf depuis https://wkhtmltopdf.org/downloads.html, puis installez-le avec cette commande :

terminal
sudo dpkg -i wkhtmltox_file.deb

Dépendances communes

Installer nvm, node et yarn

Nous recommandons d’installer Node avec nvm :

terminal
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

Une fois nvm installé, il peut être nécessaire de fermer votre terminal et d’en ouvrir un nouveau, ou de recharger le fichier de configuration de votre shell avec source (par exemple ~/.bashrc ou ~/.zshrc). Lancez ensuite la commande suivante pour installer Node :

terminal
nvm install 24

Vérifiez la version installée :

terminal
$ node -v
v24.12.0

Enfin, installez yarn avec npm :

terminal
npm install -g yarn

Installer uv et Python

Nous recommandons de gérer Python avec uv :

terminal
curl -LsSf https://astral.sh/uv/install.sh | sh

Une fois uv installé, il peut là aussi être nécessaire de fermer votre terminal et d’en ouvrir un nouveau, ou de recharger le fichier de configuration de votre shell avec source (~/.bashrc ou ~/.zshrc). Lancez ensuite la commande suivante pour installer Python :

terminal
uv python install 3.14 --default

Pour la version 15 de Frappe, vous pouvez aussi choisir une version de Python comprise entre 3.10 et 3.13.

Installer la CLI bench

Installez bench :

terminal
uv tool install frappe-bench

Vérifiez l’installation en affichant la version :

terminal
bench --version

Créez votre premier bench :

terminal
mkdir ~/frappe
cd ~/frappe
bench init my-bench

Félicitations, bench est maintenant installé sur votre système.

Pages liées