生产环境要求
在运行由你自行管理的生产环境 n8n 部署之前,请确认你的数据库、操作系统、运行时、存储和部署工具满足 n8n 的要求。
提示
想要快速入门? 你不需要这个页面。一行设置只需要 Docker,并会为你处理数据库和存储。使用 Docker Compose 安装默认使用内置的 SQLite 数据库,PostgreSQL 是可选步骤。当你转向生产环境、自行运行 PostgreSQL、使用队列模式,或部署到 Kubernetes 或裸机时,再使用本页。
数据库
本节适用于在生产环境中运行 n8n 的情况。一行设置和 Docker Compose 指南默认使用 n8n 内置的 SQLite 数据库,适合测试和小规模设置。
n8n 需要一个数据库来存储工作流、凭据和执行历史记录。
- PostgreSQL: n8n 建议在生产环境中使用 PostgreSQL,并使用受支持的 PostgreSQL 版本。
- SQLite: n8n 不支持在队列模式下使用 SQLite,也不建议将其用于多用户生产环境。
- 数据库用户权限: n8n 数据库用户必须能够连接数据库、在配置的 schema 中使用和创建对象,并在迁移期间修改或删除 n8n 的表。最简单的设置是让 n8n 用户拥有它所创建的表。示例请参阅所需权限。
有关配置 PostgreSQL 的环境变量,请参阅选择 n8n 的数据库。
操作系统和运行时
- 操作系统: n8n 建议在生产环境中使用 64 位 Linux 主机。
- Node.js: 在 n8n 2.x 中,只有 npm 安装才需要 Node.js。Docker 和 Kubernetes 安装已包含正确的版本。受支持的 Node.js 版本请参阅使用 npm 安装。从 n8n 3.0 开始,n8n 不再支持 npm 安装,因此你需要基于 Docker 的部署。请参阅 v3.0 破坏性变更。
存储
一行设置和 Docker Compose 指南会将 n8n 的数据存储在 Docker 卷中,因此你无需为它们设置存储。如果你调整了其中任一设置,请保留一个用于 n8n 数据的卷。本节适用于生产部署以及启用了队列模式的部署,这些情况下需要你自行管理存储。
对于这些部署,请规划以下内容:
- n8n 数据目录: 为 n8n 数据目录提供持久卷。该目录保存加密密钥以及(启用时的)文件日志。在文件系统模式下(从 n8n 2.0 起为常规模式的默认值),它还保存本地二进制数据。
- PostgreSQL 数据: 如果你自行运行 PostgreSQL,请为 PostgreSQL 数据提供持久卷。
- 队列模式下的二进制数据: 除非你配置了其他存储模式,否则 n8n 默认将二进制数据存储在数据库中。如果你的许可证包含相应的外部存储选项,可以使用 AWS S3 或 Azure Blob Storage。如果你使用文件系统存储,所有处理二进制数据的主实例、worker 和 webhook 处理器都必须能在相同的配置路径下访问同一个共享卷。数据库模式会增大 PostgreSQL 数据库的体积。如果你的许可证包含外部存储,队列模式下请优先使用外部存储。详情请参阅处理二进制数据。
Redis
本节仅在你启用队列模式时适用。
在队列模式下,Redis 在 n8n 主实例和其 worker 之间保存待处理执行的队列状态,而 PostgreSQL 保存你的工作流和执行数据。如果 Redis 丢失了排队的作业,n8n 不会从 PostgreSQL 重建它们,而是将受影响的执行标记为崩溃。请根据你能容忍的工作丢失程度来配置 Redis 的持久化和可用性。请提供一个主实例和每个 worker 都能访问的 Redis 实例。连接设置请参阅启动 Redis。
网络
本节适用于向用户或外部服务公开的生产部署。
端口
| 端口 | 组件 | 用途 |
|---|---|---|
| 5678 | n8n | HTTP API、编辑器 UI 和 webhook。这是 N8N_PORT 的默认值。 |
| 5432 | PostgreSQL | 数据库连接。这是 PostgreSQL 的默认端口。 |
| 6379 | Redis | 队列模式下的队列通信。这是 Redis 的默认端口。请使用你的 Redis 服务的端口和 TLS 设置,因为托管服务通常为 TLS 使用不同的端口。 |
| 5679 | n8n task broker | 来自外部 task runner 的连接。这是 N8N_RUNNERS_BROKER_PORT 的默认值。broker 默认监听 127.0.0.1。如果 runner 无法通过回环地址连接,请将 N8N_RUNNERS_BROKER_LISTEN_ADDRESS 设置为它们可以访问的绑定地址。请保持该端口私有,并只允许 runner 访问。 |
防火墙规则
请至少按以下要求配置防火墙:
- n8n 主实例和 worker 可以访问 PostgreSQL,以及(在队列模式下)Redis。
- 你的负载均衡器或反向代理可以通过 5678 端口访问 n8n 主实例。
- n8n 具有出站互联网访问权限,可以访问工作流使用的外部服务。如果你在气隙环境中运行 n8n,并且工作流只调用内部服务,则不适用此项。
- 用户可以从其所在网络,通过负载均衡器或反向代理访问编辑器 UI。
- 调用你的 webhook 的服务可以访问 webhook URL;如果调用方位于外部,则需要能通过互联网访问。
- 如果你运行多个主实例,负载均衡器需要使用粘性会话。请参阅启用队列模式。
不要将 n8n 进程直接暴露到互联网,请在其前面放置反向代理或负载均衡器。
DNS
创建一条 DNS 记录,将主机名(例如 n8n.example.com)指向你的负载均衡器或反向代理。你会在 N8N_HOST、N8N_EDITOR_BASE_URL 和 N8N_WEBHOOK_URL 环境变量中使用此主机名。N8N_HOST 接受主机名(n8n.example.com)。N8N_EDITOR_BASE_URL 和 N8N_WEBHOOK_URL 接受完整 URL(https://n8n.example.com/)。N8N_WEBHOOK_URL 从 n8n 2.30.0 起可用;在更早的版本上,请使用 WEBHOOK_URL。
在反向代理之后,还需要设置 N8N_PROXY_HOPS,它控制 n8n 是否信任转发标头中的客户端 IP 和协议。有关 n8n 如何在代理之后构建 webhook URL 以及如何设置 N8N_PROXY_HOPS,请参阅使用反向代理配置 webhook URL。
TLS
为你的主机名提供 TLS 证书。n8n 建议在反向代理或负载均衡器上终止 TLS;如果进行相应配置,它们还可以续订证书。有关如何为 n8n 设置 SSL,请参阅设置 SSL。在 Kubernetes 上,cert-manager 可以签发和续订证书。
软件依赖项
选择与你部署 n8n 的方式相匹配的小节。
Docker
- 受支持版本的 Docker Engine 或 Docker Desktop。
- Docker Compose v2 插件,用于基于 Compose 的设置。
安装步骤请参阅使用 Docker Compose 安装。
Kubernetes
- 官方 n8n Helm chart 支持的 Kubernetes 版本。chart 在
Chart.yaml中声明了其支持的版本范围。 - 已配置为可访问你的集群的
kubectl。 - Helm,用于基于 Helm 的部署。
- 受支持的 Ingress 控制器,例如 AWS Load Balancer Controller。
裸机
提示
功能可用性
在 n8n 2.x 中可以使用 npm 进行裸机安装。从 n8n 3.0 开始,n8n 不再支持 npm 安装,因此你需要基于 Docker 的部署。请参阅 v3.0 破坏性变更。
- 受支持的 Node.js 版本。请参阅使用 npm 安装。
- npm,随 Node.js 一起提供。
- 进程管理器,例如 PM2 或
systemd。 - 用于 SSL 终止的反向代理,例如 NGINX 或 Caddy。
部署前检查清单
请将此检查清单用于生产部署。跳过不适用于你的设置的项目,例如未使用队列模式时的 Redis,或未使用外部存储时的外部存储。
- [ ] 如果你使用 Business 或 Enterprise 功能,已获取许可证密钥并准备好激活。
- [ ] 已提供 PostgreSQL 并可访问,且版本受支持。
- [ ] 已提供 Redis 并可访问(仅限队列模式)。
- [ ] 如果你使用外部存储,已创建外部存储的 bucket 或容器。
- [ ] DNS 记录已指向你的负载均衡器。
- [ ] 已提供 TLS 证书,或已配置 cert-manager。
- [ ] 已配置防火墙规则。
- [ ] 持久卷可用。
- [ ] 已生成加密密钥并安全存储,且在每个 n8n 实例上设置为相同的值。运行
openssl rand -hex 32生成一个密钥。 - [ ] 已确定备份策略。