GitHub 凭据

这些凭据可用于以下节点的身份验证：

• GitHub
• GitHub Trigger（触发器）
• GitHub Document Loader（文档加载器）：此节点不支持 OAuth。

前置条件

创建一个 GitHub 账号。

支持的身份验证方式

• API access token（API 访问令牌）：可用于任何 GitHub 节点。
• OAuth2：仅用于 GitHub 和 GitHub Trigger（触发器）节点，不用于 GitHub Document Loader（文档加载器）。

相关资源

有关该服务的更多信息，请参阅 GitHub API 文档。

使用 API 访问令牌

配置此凭据需要一个 GitHub 账户。

设置此凭据需要两个步骤：

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

详细说明，请参阅下方各节。

生成个人访问令牌

信息

建议的访问令牌类型

n8n 建议使用经典个人访问令牌。GitHub 的细粒度个人访问令牌可将访问限定到特定仓库和权限，但有一些限制。

生成个人访问令牌的步骤如下：

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

更多信息，请参阅创建经典个人访问令牌；GitHub 作用域的更多信息，请参阅 OAuth 应用作用域。

设置凭据

然后在 n8n 凭据中：

1. 未使用 GitHub Enterprise Server 时，不要修改 GitHub server（GitHub 服务器）的 URL。
   • 使用 GitHub Enterprise Server 时，更新 GitHub server（GitHub 服务器），使其与服务器 URL 一致。
2. 按照 GitHub 个人资料中显示的名称，输入 User（用户）名称。
3. 输入上面生成的 Access Token（访问令牌）。

使用 OAuth2

信息

n8n Cloud 用户须知

Cloud 用户无需提供连接详情。选择 Connect my account（连接我的账号），通过浏览器连接。

如果自托管 n8n，请创建新的 GitHub OAuth 应用：

1. 打开 GitHub 个人资料的设置。
2. 在左侧导航栏选择 Developer settings（开发者设置）。
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 应用文档。