跳到主要内容

为环境设置源代码管理

将 Git 仓库连接到 n8n 实例,并配置源代码管理。

n8n 使用源代码管理提供环境功能。更多信息请参阅 n8n 中的环境。

前提条件 ​

要在 n8n 中使用源代码管理,需要一个支持以下任一访问方式的 Git 仓库:

  • SSH 访问(使用部署密钥),或
  • HTTPS 访问(使用个人访问令牌)。

本文假定你已熟悉 Git 及所用的 Git 托管平台。

第一步:设置仓库和分支 ​

全新配置的操作如下:

  1. 创建供 n8n 使用的新仓库。
  2. 创建所需分支。例如,计划使用不同的测试和生产环境时,为每个环境设置一个分支。

如需确定使用场景所需的分支,请参阅分支模式。

第二步:在 n8n 中配置 Git ​

  1. 前往 Settings(设置)> Environments(环境)。
  2. 选择连接方式:
    • SSH:在 Git repository URL(Git 仓库 URL)中填写仓库的 SSH URL(例如 git@github.com:username/repo.git)。
    • HTTPS:在 Git repository URL(Git 仓库 URL)中填写仓库的 HTTPS URL(例如 https://github.com/username/repo.git)。
  3. 根据连接方式配置身份验证:
    • SSH:n8n 支持 ED25519 和 RSA 公钥算法,默认为 ED25519。如果 Git 主机要求 RSA,请在 SSH Key(SSH 密钥)下选择 RSA。复制 SSH 密钥。
    • HTTPS:填写凭据:
      • Username(用户名):Git 托管平台的用户名。
      • Token(令牌):Git 托管平台的个人访问令牌(PAT)。

第三步:设置身份验证 ​

根据所选连接方式配置身份验证。

SSH 身份验证(使用部署密钥) ​

使用 n8n 提供的 SSH 密钥,为仓库创建部署密钥,以设置 SSH 访问。该密钥必须具有写入权限。

具体步骤取决于 Git 托管平台。常用平台的帮助链接:

HTTPS 身份验证(使用个人访问令牌) ​

创建具有仓库访问权限的个人访问令牌(PAT)。

常用平台创建 PAT 的帮助链接:

令牌需要具备以下权限:

  • 仓库读写权限。
  • Contents 读写权限(GitHub)。
  • 源代码拉取和推送权限(GitLab)。

使用私有证书颁发机构的 Git 主机 ​

信息

功能可用范围

自 n8n 2.40.0 起,Git 连接支持私有证书颁发机构。

如果 Git 主机使用私有证书颁发机构(CA)签发的证书,请在 n8n 实例上将 GIT_SSL_CAINFO 环境变量设为包含 CA 证书的 PEM 文件路径。Git 使用自己的信任存储,因此 n8n 的自定义证书颁发机构配置不适用于 Git 连接。如果将证书保存在使用 c_rehash 建立索引的目录中,则将 GIT_SSL_CAPATH 设为该目录。

该文件或目录会替代 Git 的默认信任存储。如果实例还需要连接公共 Git 主机,请同时包含其根证书。

第四步:连接 n8n 并配置实例 ​

  1. 在 n8n 的 Settings(设置)> Environments(环境)中,选择 Connect(连接)。n8n 会连接到 Git 仓库。
  2. 在 Instance settings(实例设置)下,选择当前 n8n 实例要使用的分支。
  3. 可选:选择 Protected instance(受保护实例),阻止用户编辑本实例中由源代码管理控制的资源。此选项适合保护生产实例。
  4. 可选:为实例选择自定义颜色。此颜色会显示在菜单中源代码管理推送、拉取按钮旁,帮助用户识别当前实例。
  5. 选择 Save settings(保存设置)。

相关资源 ​

本文为社区中文翻译。查看对应英文原文