n8n 中文文档

教程:使用源代码控制创建环境

提示

Feature availability 功能可用性

  • 适用于商业和企业计划。
  • 您必须是 n8n 实例所有者或实例管理员才能启用和配置源代码控制。
  • 实例所有者和实例管理员可以将更改推送到连接的存储库或从连接的存储库中提取更改。
  • 项目管理员可以将更改推送到连接的存储库。他们无法从存储库中提取更改。

本教程将逐步介绍端到端设置环境的过程。您将创建两个环境:开发和生产。它使用 GitHub 作为 Git 提供者。其他提供商的流程类似。

n8n 在版本控制软件 Git 之上构建了其环境功能。您将 n8n 实例链接到 Git 分支,并使用推拉模式在环境之间移动工作。您应该对环境和 Git 有一定的了解。如果您需要有关这些主题的更多信息,请参阅:

选择您的源代码控制模式

在设置源代码控制和环境之前,您需要规划您的环境以及它们与 Git 分支的关系。 n8n 支持不同的分支模式。对于环境,您需要在两种模式之间进行选择:多实例、多分支,或多实例、单分支。本教程涵盖了这两种模式。

提示

Recommendation: don't push and pull to the same n8n instance 建议:不要推送和拉取到同一个 n8n 实例

您可以将工作从实例推送到分支,然后拉取到同一实例。 n8n 不推荐这样做。为了降低合并冲突和覆盖工作的风险,请尝试创建一个流程,使工作朝一个方向进行:要么到 Git,要么从 Git,但不能同时进行。

多个实例,多个分支

开发 n8n 实例连接到开发分支,生产实例连接到生产分支

提示

Feature availability 功能可用性

  • 适用于商业和企业计划。
  • 您必须是 n8n 实例所有者或实例管理员才能启用和配置源代码控制。
  • 实例所有者和实例管理员可以将更改推送到连接的存储库或从连接的存储库中提取更改。
  • 项目管理员可以将更改推送到连接的存储库。他们无法从存储库中提取更改。

多个实例,一个分支

开发和生产 n8n 实例共同连接到同一个 Git 分支

提示

Feature availability 功能可用性

  • 适用于商业和企业计划。
  • 您必须是 n8n 实例所有者或实例管理员才能启用和配置源代码控制。
  • 实例所有者和实例管理员可以将更改推送到连接的存储库或从连接的存储库中提取更改。
  • 项目管理员可以将更改推送到连接的存储库。他们无法从存储库中提取更改。

设置您的存储库

选择模式后,您需要设置 GitHub 存储库。

Multi-branch

  1. 创建新存储库。
    • 确保存储库是私有的,除非您希望将工作流程、标签以及变量和凭证存根暴露在互联网上。
    • 使用自述文件创建新存储库,以便您可以立即创建分支。
  2. 创建一个名为 production 的分支和另一个名为 development 的分支。请参阅在存储库中创建和删除分支 以获取指导。

Single-branch

创建新存储库。

  • 确保存储库是私有的,除非您希望将工作流程、标签以及变量和凭证存根暴露在互联网上。
  • 使用自述文件创建新存储库。这将创建您将连接到的 main 分支。

将您的 n8n 实例连接到存储库

创建两个 n8n 实例,一个用于开发,一个用于生产。

在 n8n 中配置 Git

  1. 进入 Settings 设置 > Environments 环境。
  2. 选择您的连接方式:
    • SSH:在 Git repository URL Git 存储库 URL 中,输入存储库的 SSH URL(例如,[email protected]:username/repo.git)。
    • HTTPS:在 Git repository URL Git 存储库 URL 中输入存储库的 HTTPS URL(例如,https://github.com/username/repo.git)。
  3. 根据您的连接方式配置身份验证:
    • For SSH 对于SSH:n8n 支持 ED25519 和 RSA 公钥算法。 ED25519 是默认值。如果您的 git 主机需要 RSA,请选择 SSH Key SSH 密钥 下的 RSA。复制 SSH 密钥。
    • For HTTPS 对于 HTTPS:输入您的凭据:
      • Username 用户名:您的 Git 提供商用户名。
      • Token 代币:来自 Git 提供商的个人访问令牌 (PAT)。

设置部署密钥

通过使用 n8n 中的 SSH 密钥为存储库创建部署密钥来设置 SSH 访问。该密钥必须具有写入权限。参考GitHub |管理部署密钥 获取指导。

连接 n8n 并配置您的实例

Multi-branch

  1. 在 n8n 中的 Settings 设置 > Environments 环境 中,选择 Connect 连接。 n8n 连接到您的 Git 存储库。
  2. 在 Instance settings 实例设置 下,选择要用于当前 n8n 实例的分支。将生产分支连接到生产实例,将开发分支连接到开发实例。
  3. 仅生产实例:选择 Protected instance 受保护实例 以防止用户在此实例中编辑工作流程。
  4. 选择 Save settings 保存设置。

Single-branch

  1. 在 n8n 中的 Settings 设置 > Environments 环境 中,选择 Connect 连接。
  2. 在Instance settings 实例设置下,选择主分支。
  3. 仅生产实例:选择 Protected instance 受保护实例 以防止用户在此实例中编辑工作流程。
  4. 选择 Save settings 保存设置。

开发中的推送工作

在您的开发实例中,创建一些工作流程、标签、变量和凭据。

要将工作推送到 Git:

  1. 在主菜单中选择 Push Push icon。
  2. 在 Commit and push changes 模态框中,选择要推送的工作流和 data tables。你可以按状态(new、modified、deleted)过滤并搜索项目。n8n 会自动推送 tags,以及变量和凭据 stub。

    n8n 推送的是工作流当前保存的版本,而不是已发布版本。之后你需要在远程服务器上单独发布版本。

  3. 输入 commit message。它应当用一句话描述你正在进行的更改。

  4. 选择 Commit and Push。n8n 会将工作发送到 Git,并在完成时显示成功消息。

将工作拉入生产

您的作品现已在 GitHub 中。如果您使用多分支设置,则它位于开发分支上。如果您选择单分支设置,则它位于主分支上。

Multi-branch

  1. 在 GitHub 中,创建拉取请求以将开发合并到生产中。
  2. 合并拉取请求。
  3. 在您的生产实例中,在主菜单中选择“Pull 拉动 Pull icon”。

Single-branch

在您的生产实例中,在主菜单中选择 Pull 拉动 Pull icon。

查看截图
菜单关闭时拉动和按下按钮
菜单打开时拉动和按下按钮

可选:使用 GitHub Action 自动拉取

如果您想避免登录生产实例进行拉取,则可以使用 GitHub Action 和 n8n API 在每次将新工作推送到生产或主分支时自动拉取。

GitHub 操作示例:

name: CI
on:
  # 在"production"分支的推送或拉取请求事件时触发工作流
  push:
    branches: [ "production" ]
  # 允许您从 Actions 选项卡手动运行此工作流
  workflow_dispatch:
jobs:
  run-pull:
    runs-on: ubuntu-latest
    steps:
      - name: PULL
                # 使用 GitHub secrets 保护敏感信息
        run: >
          curl --location '${{ secrets.INSTANCE_URL }}/version-control/pull' --header
          'Content-Type: application/json' --header 'X-N8N-API-KEY: ${{ secrets.INSTANCE_API_KEY }}'

后续步骤

了解更多:

相关资源

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