安装

系统要求

本指南假设您使用的是个人电脑、VPS 或裸机服务器。您还需要使用 *nix 系统,因此支持任何 Linux 发行版和 macOS。如果您是 Windows 用户,可以在 WSL 中使用 Ubuntu。我们仅正式支持以下发行版。

  1. macOS
  2. Debian / Ubuntu

在此处了解更多关于架构的信息。

前置要求

依赖项 Frappe v14/v15 Frappe v16/develop
MariaDB 10.6.6+ 11.8
Python 3.10+ 3.14
NodeJS 18+ 24
Redis / valkey 6 6+
Yarn 1.12+ 1.22+
pip 20+ 25.3+
  • wkhtmltopdf:0.12.6 版本,带有修补过的 qt – 用于生成 PDF
  • cron:bench 的定时任务 – 自动证书续期、定时备份

macOS

安装 Xcode 工具的命令行版本。

xcode-select --install

安装 Homebrew。它可以让您在 macOS 上轻松安装软件包。

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

(它可能会在最后提示您运行一些额外的命令,这将确保 brew 在您的 PATH 中可用)

安装 wkhtmltopdf

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 ~

现在,您可以通过运行以下命令轻松安装所需的软件包

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

如果您计划使用 PostgreSQL 而不是 MariaDB,那么您可以包含 postgresql

在此安装过程中,系统会提示您设置 MySQL root 密码。如果没有提示,您需要自行初始化 MySQL 服务器设置。您可以通过运行以下命令来完成:

sudo mariadb-secure-installation

请记住:仅在设置过程中未提示您输入密码时才运行此命令。

然后,继续执行通用步骤

Debian / Ubuntu

您应该运行 Debian 13+ 或 Ubuntu 24.04+,否则某些软件包可能会出现问题。

更新您系统的软件包索引

sudo apt update

安装 gitredismariadb

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

在此安装过程中,系统会提示您设置 MySQL root 密码。如果没有提示,您需要自行初始化 MySQL 服务器设置。您可以通过运行以下命令来完成:

sudo mariadb-secure-installation

请记住:仅在设置过程中未提示您输入密码时才运行此命令。

请务必记住此密码,因为稍后会用到它。

安装 wkhtmltopdf

sudo apt install xvfb libfontconfig

从 https://wkhtmltopdf.org/downloads.html 下载并安装 wkhtmltopdf 软件包,然后运行此命令来安装该软件包。

sudo dpkg -i wkhtmltox_file.deb

通用依赖项

安装 nvm、node 和 yarn

我们建议使用 nvm 安装 node

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

nvm 安装完成后,您可能需要关闭终端并打开另一个标签页/窗口,或者 source 您的 shell 的 rc 文件(例如:~/.bashrc~/.zshrc。然后运行以下命令来安装 node。

nvm install 24

通过运行以下命令验证已安装的版本:

$ node -v
v24.12.0

最后,使用 npm 安装 yarn

npm install -g yarn

** 安装 uv 和 python **

我们建议使用 uv 来管理 python

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

uv 安装完成后,您可能需要关闭终端并打开另一个标签页/窗口,或者 source 您的 shell 的 rc 文件(例如:~/.bashrc~/.zshrc。然后运行以下命令来安装 python。

uv python install 3.14 --default

或者,对于版本 15,您可以选择 3.10-3.13 之间的版本。

安装 Bench CLI

通过 pip 安装 bench

uv tool install frappe-bench

通过检查版本来确认 bench 安装成功

bench --version

创建您的第一个 bench。

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

恭喜,您已在系统上成功安装了 bench。