n8n 中文文档

警告

Feature availability 功能可用性

n8n 3.0 起弃用基于 npm 的安装。

提示

n8n Assistant 不可用

使用 npm 安装方法时,n8n Assistant 不可用。

npm 是在本地计算机上快速开始使用 n8n 的方式。您必须安装 Node.js。n8n 需要 20.19 至 24.x(含)之间的 Node.js 版本。

尝试使用 n8n 和 npx

您可以使用 npx 试用 n8n,而无需安装它。

从终端运行:

npx n8n

此命令会下载启动 n8n 所需的一切。然后,打开 http://localhost:5678{:target=_blank .external-link} 即可访问 n8n 并开始构建工作流。

使用 npm 进行全局安装

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

npm install n8n -g

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

npm install -g [email protected]

要安装 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 带隧道

危险

使用它进行本地开发和测试。在生产中使用它并不安全。

警告

Development tooling 开发工具

隧道功能是本地开发的便捷工具。n8n 版本之间的底层实现可能会发生变化。

观看一个使用 Cloudflare 或 ngrok 设置隧道的视频指南:

https://www.youtube.com/embed/O9dpO81dEQ0

要使用 GitHub 等外部服务的触发器节点的 webhook,n8n 必须可以从网络访问。n8n 使用 cloudflared 提供隧道服务,将网络请求重定向到你本地的 n8n 实例。隧道功能需要安装 Docker。

根据你运行 n8n 的方式,有两种使用隧道的方法:

提示

Docker required 需要 Docker

该隧道使用 cloudflared,它作为 Docker 容器运行。确保 Docker 安装在您的计算机上,即使通过 npm 运行 n8n 也是如此。

对于 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,并将包含 WEBHOOK_URL 和 N8N_PROXY_HOPS=1 的 .env 文件写入 packages/cli/bin/.env。n8n 启动时会自动加载此文件。

完成后清理:

pnpm --filter n8n-containers services:clean

如需完整堆栈方案(n8n 和 cloudflared 都在容器中),请参阅 Docker 隧道设置。

恢复升级

安装您要回退到的旧版本。

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

  1. 检查功能文档和发布说明,看看是否有需要手动进行的更改。
  2. 在当前版本上运行 n8n db:revert 来回滚数据库。如果您想回退多个数据库迁移,需要重复此过程。

Windows 故障排除

如果您在 Windows 上运行 n8n 时遇到问题,请检查 Node.js 环境是否正确设置。请遵循 Microsoft 的在 Windows 上安装 NodeJS{:target=_blank .external-link} 指南。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。