GitHub 凭证#
您可以使用这些凭证来验证以下节点:
- GitHub
- GitHub Trigger
- GitHub Document Loader:该节点不支持 OAuth
先决条件#
创建一个 GitHub 账户
支持的认证方式#
- API 访问令牌:此方法可用于所有 GitHub 节点
- OAuth2:此方法仅适用于 GitHub 和 GitHub Trigger 节点;不能用于 GitHub Document Loader
相关资源#
更多关于该服务的信息,请参考 GitHub API 文档
使用 API 访问令牌#
要配置此凭证,您需要一个 GitHub 账户。
设置此凭证需要两个步骤:
详细说明请参考以下部分。
生成个人访问令牌#
推荐的访问令牌类型
n8n 推荐使用经典个人访问令牌(classic)。GitHub 的细粒度个人访问令牌仍处于测试阶段,可能无法访问所有端点。
生成个人访问令牌的步骤:
- 如果尚未验证您的 GitHub 邮箱地址,请先完成验证。详情参考验证您的邮箱地址
- 打开您的 GitHub 个人资料设置
- 在左侧导航栏中选择开发者设置
- 在左侧导航栏的个人访问令牌下,选择令牌(classic)
- 点击生成新令牌 > 生成新令牌(classic)
- 在备注字段中输入令牌的描述性名称,例如
n8n 集成
- 选择令牌的有效期,或选择永不过期
- 为令牌选择权限范围。对于大多数 n8n GitHub 节点,需要添加
repo
范围- 未分配范围的令牌只能访问公开信息
- 参考
- 点击生成令牌
- 复制生成的令牌
更多信息请参考创建经典个人访问令牌。关于 GitHub 范围的详细信息,请参阅OAuth 应用的范围
设置凭据#
接下来,在您的 n8n 凭据中:
- 如果不使用 GitHub Enterprise Server,请不要更改 GitHub server URL。
- 如果使用 GitHub Enterprise Server,请将 GitHub server 更新为您服务器的 URL。
- 输入您的 User 名称(与 GitHub 个人资料中显示的一致)。
- 输入您之前生成的 Access Token。
使用 OAuth2 认证#
/// 注意 | 针对 n8n Cloud 用户的提示 云版本用户无需提供连接详细信息。选择 连接我的账户 即可通过浏览器完成连接。 ///
如果您是自托管 n8n,请创建一个新的 GitHub OAuth 应用:
- 打开您的 GitHub 个人资料 Settings。
- 在左侧导航栏中选择 Developer settings。
- 在左侧导航栏中选择 OAuth apps。
- 选择 New OAuth App。
- 如果之前未创建过应用,可能会看到 Register a new application,请选择它。
- 输入 Application name,例如
n8n integration
。 - 输入应用的 Homepage URL。
- 可选:添加 Application description(GitHub 会向最终用户显示此描述)。
- 从 n8n 复制 OAuth Redirect URL 并粘贴到 GitHub 的 Authorization callback URL 中。
- 选择 Register application。
- 复制生成的 Client ID 和 Client Secret 并添加到您的 n8n 凭据中。
有关授权流程的更多信息,请参阅 GitHub 授权 OAuth 应用文档。