跳到主要内容

or

注意

功能可用范围

从 n8n 3.0 开始,基于 npm 的安装方式已弃用。

信息

不支持 n8n Assistant

通过 npm 安装时,无法使用 n8n Assistant。

npm 是在本地计算机上快速开始使用 n8n 的一种方式。你必须先安装 Node.js。n8n 要求 Node.js 版本介于 20.19 和 24.x 之间,包含这两个版本。

使用 npx 试用 n8n ​

使用 npx 可以免安装试用 n8n。

在终端中运行:

npx n8n

该命令会下载启动 n8n 所需的全部内容。然后打开 http://localhost:5678,即可访问 n8n 并开始构建工作流。

使用 npm 全局安装 ​

要全局安装 n8n,请使用 npm:

npm install n8n -g

要安装或更新到特定 n8n 版本,请使用 @ 语法指定版本。例如:

npm install -g n8n@0.126.1

安装 next:

npm install -g n8n@next

安装后,运行以下命令启动 n8n:

n8n
# or <a href="#or" id="or"></a>
n8n start

后续步骤 ​

按照快速入门试用 n8n。

更新 ​

要将 n8n 实例更新为 latest 版本,请运行:

npm update -g n8n

安装 next 版本:

npm install -g n8n@next

通过隧道运行 n8n ​

危险

此功能用于本地开发和测试,不适合安全地用于生产环境。

注意

开发工具

隧道功能是方便本地开发的工具,其底层实现可能随 n8n 版本变化。

观看视频指南,了解如何通过 Cloudflare 或 ngrok 配置隧道:

要使用 GitHub 等外部服务触发器节点的 Webhook,n8n 必须能从互联网访问。n8n 提供基于 cloudflared 的隧道服务,将互联网请求转发到本地 n8n 实例。隧道运行需要安装 Docker。

根据 n8n 的运行方式,可以通过两种方式使用隧道:

信息

需要 Docker

隧道使用 cloudflared,并将其作为 Docker 容器运行。即使通过 npm 运行 n8n,也请确保计算机上已安装 Docker。

对于 npm 安装,请使用仅服务方式。先将 cloudflared 作为独立服务启动,再在本地运行 n8n:

# Terminal 1: Start the cloudflared tunnel service <a href="#terminal-1-start-the-cloudflared-tunnel-service" id="terminal-1-start-the-cloudflared-tunnel-service"></a>
pnpm --filter n8n-containers services --services cloudflared

# Terminal 2: Start n8n locally <a href="#terminal-2-start-n8n-locally" id="terminal-2-start-n8n-locally"></a>
pnpm dev

services 命令会启动 cloudflared、获取公共隧道 URL,并将 .env 文件写入 packages/cli/bin/.env,其中包含 WEBHOOK_URL 和 N8N_PROXY_HOPS=1。n8n 会在启动时自动读取此 .env。

完成后清理:

pnpm --filter n8n-containers services:clean

如果希望使用完整堆栈方式(n8n 和 cloudflared 均在容器中运行),请参阅 Docker 隧道配置。

回退升级 ​

安装希望回退到的旧版本。

如果升级涉及数据库迁移:

  1. 检查功能文档和更新记录,确认是否需要手动修改。
  2. 在当前版本上运行 n8n db:revert,回滚数据库。如果需要撤销多次数据库迁移,必须重复此过程。

Windows 故障排查 ​

如果在 Windows 上运行 n8n 时遇到问题,请检查 Node.js 环境设置。按照 Microsoft 的在 Windows 上安装 NodeJS指南操作。

相关资源 ​

本文为社区中文翻译。查看对应英文原文