N8N中文教程
集成节点/Built in_nodes/Credentials

GitHub 凭据#

你可以使用这些凭据来认证以下节点:

  • GitHub
  • GitHub Trigger
  • GitHub Document Loader:该节点不支持 OAuth。

前提条件#

创建一个 GitHub 账户。

支持的认证方式#

  • API 访问令牌(API access token):可用于任何 GitHub 节点。
  • OAuth2:仅可用于 GitHub 和 GitHub Trigger 节点;不可用于 GitHub Document Loader。

相关资源#

更多服务信息,请参考 GitHub 的 API 文档。

使用 API 访问令牌#

要配置此凭据,你需要一个 GitHub 账户。 配置此凭据分为两个步骤:

  1. 生成 GitHub 个人访问令牌。
  2. 设置凭据。

请参考以下各部分以获取详细说明。

生成个人访问令牌#

推荐的访问令牌类型 n8n 推荐使用个人访问令牌(classic)。GitHub 的细粒度个人访问令牌(fine-grained personal access tokens)目前仍处于测试阶段,无法访问所有 API 端点。

要生成你的个人访问令牌,请执行以下步骤:

  1. 如果尚未完成,请先验证你在 GitHub 上的邮箱地址。更多信息请参考 验证你的邮箱地址。
  2. 打开你的 GitHub 个人资料页面中的 设置(Settings)。
  3. 在左侧导航栏中,选择 开发者设置(Developer settings)
  4. 在左侧导航栏中,找到 个人访问令牌(Personal access tokens),然后选择 令牌(classic)(Tokens (classic))
  5. 选择 生成新令牌 > 生成新令牌(classic)(Generate new token > Generate new token (classic))
  6. 备注(Note) 字段中输入一个具有描述性的名称,例如 n8n integration
  7. 选择你希望令牌的 有效期(Expiration),或选择 永不过期(No expiration)
  8. 为你的令牌选择 作用域(Scopes)。对于大多数 n8n GitHub 节点,建议添加 repo 作用域。
    • 未分配作用域的令牌只能访问公开信息。
    • 更多信息请参考
  9. 选择 生成令牌(Generate token)
  10. 复制生成的令牌。

更多信息请参考 创建个人访问令牌(classic)。关于 GitHub 作用域(scopes)的详细信息,请参考 OAuth 应用的作用域(Scopes for OAuth apps)。

配置凭证#

然后,在你的 n8n 凭证中:

  1. 如果你没有使用 GitHub Enterprise Server,则无需更改 GitHub server URL。
    • 如果你正在使用 GitHub Enterprise Server,请将 GitHub server 更新为你的服务器 URL。
  2. 输入你的 用户(User) 名称,即你在 GitHub 个人资料中显示的用户名。
  3. 输入你上面生成的 访问令牌(Access Token)

使用 OAuth2

n8n Cloud 用户请注意 Cloud 用户无需提供连接详情。选择 Connect my account 即可通过浏览器完成连接。 如果您是 自托管 n8n,请创建一个新的 GitHub OAuth 应用:

  1. 打开您的 GitHub 个人资料 设置页面。
  2. 在左侧导航栏中,选择 开发者设置
  3. 在左侧导航栏中,选择 OAuth apps(OAuth 应用)。
  4. 选择 New OAuth App(新建 OAuth 应用)。
    • 如果您之前未创建过应用,可能会看到“Register a new application”(注册新应用),请选择该项。
  5. 输入 Application name(应用名称),例如 n8n integration
  6. 输入您应用网站的 Homepage URL(主页 URL)。
  7. 可选地,添加 Application description(应用描述),GitHub 将向最终用户显示此信息。
  8. 从 n8n 中复制 OAuth Redirect URL(OAuth 重定向 URL),并粘贴到 GitHub 的 Authorization callback URL(授权回调 URL)字段中。
  9. 选择 Register application(注册应用)。
  10. 复制生成的 Client ID(客户端 ID)和 Client Secret(客户端密钥),并将它们添加到您的 n8n 凭据中。

有关授权流程的更多信息,请参考 GitHub OAuth 应用授权文档。