n8n 中文文档

一行设置

适用对象

本指南使用一条命令设置全新的 n8n 实例,取代旧的 npm install n8n / npx n8n 方法;从 n8n 3.0 起这些方法将不再适用。无论您以前是否使用过 Docker,这都是运行 n8n 的最快方式。

它适用于全新安装,而不是更改现有设置:

  • 已经使用自己的 Docker Compose 文件进行自托管? 无需切换到此脚本,但可以参考 Docker Compose 设置流程。
  • 目前通过 npm 安装 n8n? 从 n8n 3.0 开始,n8n 仅通过 Docker 分发。现有 npm 安装目前仍可运行,但新安装(以及未来升级)应改用此方法。

开始前的准备

此方法使用 Docker,这是一种在独立软件包中运行 n8n 的工具,因此您无需自行安装或配置任何其他内容。如果您还没有:

  • 安装 Docker。Docker 安装包包含 Docker Compose,而设置命令也需要它。

您无需了解 Docker;只要安装并让它在后台运行即可。

提示

一行设置命令需要 docker compose v2 插件(而不是较旧的独立 docker-compose 二进制文件),并会检查 Docker 守护进程是否正在运行。如果使用 Podman、Colima 或其他兼容 Docker 的引擎,请安装带 Compose 插件的 docker CLI,并将 DOCKER_HOST 指向其套接字。

请观看视频指南,了解从安装 Docker 到启用 n8n Assistant的完整流程:

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

运行命令

打开终端并运行:

curl -fsSL https://get.n8n.io | sh

该命令会自动完成以下工作:

  1. 检查 Docker 是否已安装且正在运行;如果未满足条件,会告诉您如何修复。
  2. 在当前目录创建名为 n8n 的文件夹,用于保存所有内容。
  3. 写入 n8n 所需的配置文件。
  4. 下载 n8n 并启动它。

重复运行也是安全的。如果该文件夹中已设置 n8n,命令只会提示已存在,不会修改任何内容。

成功的运行如下所示:

$ curl -fsSL https://get.n8n.io | sh

✓ Docker found (24.0.6)
✓ Docker Compose found (v2.24.0)
✓ Created ./n8n/compose.yml
✓ Created ./n8n/searxng-settings.yml
✓ Created ./n8n/.env (unique secrets generated)
Pulling images and starting (this can take a few minutes on first run)...
✓ Started n8n 2.32.0 and sandbox services

n8n is running at: http://localhost:5678
Data stored in:    ./n8n (Docker volume: n8n-data)
Config files:      ./n8n/compose.yml, ./n8n/.env

To stop:      docker compose -f ./n8n/compose.yml down
To upgrade:   curl -fsSL https://get.n8n.io | sh -s -- --upgrade
To uninstall: docker compose -f ./n8n/compose.yml down -v   # -v DELETES all n8n data
              rm -rf ./n8n

警告

n8n 第一次需要一些时间才能完成启动。该命令会等待并仅在 URL 准备就绪后才打印它。如果页面没有立即加载,请稍等一下并刷新。

默认包含的内容

运行该命令会自动设置以下组件,无需额外安装:

组件 这是做什么用的
n8n 工作流编辑器本身,在 http://localhost:5678 上运行。
内置数据库 存储工作流、凭据和执行历史记录。这是 SQLite,一种存储在文件中的轻量级数据库,无需安装或管理单独的数据库服务器。
n8n Assistant 支持服务 安全运行 n8n Assistant 所编写代码的沙箱,以及用于联网搜索的捆绑搜索工具。它们会与 n8n 一起自动启动,但在添加 AI provider key 前,助手本身保持关闭。请参阅打开 n8n Assistant。

如果要为团队或生产环境设置 n8n,建议使用更强大的数据库(例如 Postgres),而不是内置默认数据库。请参阅使用 Docker Compose 安装。

警告

捆绑沙箱仅用于开发和测试,不适用于生产环境。它的 runner(sandbox-runner-1)以 privileged: true 和 Docker-in-Docker 方式运行,隔离性较弱。如果代码逃逸出沙箱,就会触及宿主机,因此请将该 runner 视为等同于宿主机上的 root。

请在没有运行其他任何服务的专用机器或虚拟机上运行此设置,并且永远不要将其暴露到互联网。生产环境请参阅设置 n8n Assistant。其中介绍了自托管方案,即使用 Sysbox runner 的 n8n 沙箱服务,最好运行在 Kubernetes 上;托管方案是 Daytona,这是一项会接收你的工作流数据的第三方服务。

可选:打开 n8n Assistant

n8n 无需 n8n Assistant 也能完整运行;n8n Assistant 是可选功能。n8n 运行后,最简单的启用方式是在实例的 AI 设置中通过 UI 添加模型 API key。若想在首次登录前配置,请改为编辑 .env:

  1. 打开命令创建的 .env 文件(默认为 ./n8n/.env)。
  2. 将 AI provider key 添加到 N8N_INSTANCE_AI_MODEL_API_KEY 行。
  3. 重启 n8n:docker compose -f ./n8n/compose.yml up -d。

完整的设置步骤(包括支持哪些提供商)位于设置 n8n Assistant。

默认情况下,n8n Assistant 的网络搜索通过捆绑搜索工具运行,无需设置。如果更愿意使用 Brave Search,请将 Brave API key 添加到同一 .env 文件中的 INSTANCE_AI_BRAVE_SEARCH_API_KEY。设置后会自动使用。

提示

无需为这些服务打开额外端口或进行其他配置。从机器外部只能访问 n8n 本身(端口 5678);默认情况下,其他内容均保持私有。

日常命令

操作 命令
停止 n8n docker compose -f ./n8n/compose.yml down
再次启动 docker compose -f ./n8n/compose.yml up -d
升级到最新版本 curl -fsSL https://get.n8n.io \| sh -s -- --upgrade
删除 n8n 及其数据 docker compose -f ./n8n/compose.yml down -v,然后运行 rm -rf ./n8n

升级会更改什么

升级命令会将 n8n 和捆绑的沙箱服务都更新到较新版本。它会修改 .env 中的两行:N8N_VERSION 和 N8N_SANDBOX_VERSION。你的数据、secret 和其他设置保持不变。

如果是在沙箱版本移入 .env 之前安装的,compose.yml 仍会使用固定的沙箱镜像标签。首次升级会重写这些镜像行以使用 N8N_SANDBOX_VERSION,将沙箱运行器地址(SANDBOX_RUNNER_HTTP_BASE_URL)从 http:// 改为 https://,并输出相应说明。compose.yml 中的其他内容不会更改,因此你所做的编辑都会保留。

标志(用于更多控制)

将以下标志添加到安装命令末尾可改变其行为:

标志 作用
--version 单独使用时,显示脚本版本以及它将安装的最新 n8n 版本。后接版本号(例如 --version 2.31.4)时,会安装或升级到该指定版本。
--no-start 设置配置文件,但暂不启动 n8n。
--upgrade 将现有安装升级到较新的 n8n 版本及其匹配的沙箱服务版本。只更新 .env 中的版本行;对于较旧的安装,还会更新 compose.yml 中的沙箱镜像行和运行器地址。请参阅升级会更改什么。你的数据、设置和其他自定义内容不会受到影响。
--help 显示所有可用选项。

不想直接运行互联网脚本?

可以先下载并阅读脚本,再自行运行:

curl -fsSL https://get.n8n.io -o get-n8n.sh
less get-n8n.sh   # review it
sh get-n8n.sh

Windows 用户

一行设置命令需要能理解 shell 脚本的终端;标准 Windows 命令提示符和 PowerShell 不支持。请改用:

  • WSL(Linux 的 Windows 子系统),已打开 Docker Desktop 的 WSL2 集成。
  • Git Bash(与 Git for Windows 一起安装)。它也可以运行 POSIX shell 脚本,但 n8n 尚未针对一行设置命令进行端到端验证。除非确认 Git Bash 适用于您的环境,否则请使用 WSL。

相关资源

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