n8n 中文文档

从环境变量 管理社区包

提示

功能可用性

从 n8n 2.21.0 开始,可以通过环境变量管理社区包。

在自托管 n8n 上,您可以从环境变量管理已安装的社区包集。 n8n 在每次启动时根据列表协调已安装的软件包、安装缺失的软件包、更正版本以及卸载不在列表中的软件包。使用此方法通过一组固定的包引导实例,例如通过部署管道。

警告

启用此功能会卸载不在列表中的软件包

第一次使用 N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV=true 启动 n8n 时,n8n 会卸载 N8N_COMMUNITY_PACKAGES 中未包含的任何当前安装的社区软件包。如果您已通过 UI 管理包,请在启用此变量之前查看 社区节点 设置页面并将要保留的包添加到 N8N_COMMUNITY_PACKAGES。

配置

在 n8n 实例上设置以下环境变量,然后重新启动:

变量 类型 默认 描述
N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV 布尔 false 设置为 true 以从环境变量管理已安装的社区包。当 true 时,n8n 在每次启动时根据 N8N_COMMUNITY_PACKAGES 协调已安装的软件包,安装丢失的软件包,更正版本和 uninstalling any currently-installed packages that aren't in the list 卸载列表中没有的所有当前安装的软件包。 Community nodes 社区节点 设置页面变为只读:启用此功能后,您无法从 UI 安装、更新或卸载软件包。
N8N_COMMUNITY_PACKAGES JSON 字符串 - 要安装的社区包的 JSON 数组。每个条目都是一个对象,具有 name(必需)以及可选的 version 和 checksum 字段。您还可以将版本嵌入名称中,如 <package-name>@<version>。有关每个字段的完整参考,请参阅环境变量安装。

提示

必须启用社区包

N8N_COMMUNITY_PACKAGES_ENABLED 必须是 true(默认值)。如果在实例级别禁用社区包,n8n 会忽略 N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV 并在启动时记录警告。

例如:

export N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV=true
export N8N_COMMUNITY_PACKAGES='[{"name":"n8n-nodes-foo","version":"1.2.3"}]'

虽然 N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV 是 true,但 社区节点 设置页面是只读的:您无法从 UI 安装、更新或卸载软件包。

每个包字段

字段 类型 必需 说明
name 字符串 是 npm 包名称。您可以将内联版本包含为 <package-name>@<version>。如果这样做,也不要将 version 字段设置为不同的值,n8n 会拒绝冲突版本。
version 字符串 否 版本说明符。如果省略,n8n 在审查包注册表中查找包并使用该版本;如果软件包未经审查,n8n 会安装 npm 解析的任何内容,并且不会在重新启动时协调版本。
checksum 字符串 否 SHA-512 已解析 tarball 的校验和 (sha512-...)。需要设置 version。如果可能,n8n 会自动从经过审查的注册表解析校验和。

包含所有三个字段的示例:

[
  { "name": "n8n-nodes-foo", "version": "1.2.3" },
  { "name": "[email protected]" },
  { "name": "n8n-nodes-baz", "version": "2.0.0", "checksum": "sha512-..." }
]

警告

未经验证的包需要校验和

如果软件包不在 vetted-packages 注册表中并且 N8N_UNVERIFIED_PACKAGES_ENABLED 是 false,则 n8n 将无法启动。为封装固定 checksum、设置 N8N_UNVERIFIED_PACKAGES_ENABLED=true 或选择经过审查的封装。

有关设置环境变量的支持方法,请参阅 配置方法。

管理包

要添加、删除、升级或降级软件包,请编辑 N8N_COMMUNITY_PACKAGES 并重新启动 n8n。 n8n 在下次启动时与新列表协调。

警告

版本中的重大更改

节点开发人员可能会在其节点的新版本中引入重大更改。重大更改是指破坏以前功能的更新。更改版本时要小心。如果新版本导致问题,请将version设置回之前的值并重新启动n8n以回滚。

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