GitHub 凭据#
您可以使用这些凭据来验证以下节点:
- GitHub
- GitHub Trigger
- GitHub Document Loader:此节点不支持 OAuth。
先决条件#
创建一个 GitHub 账户。
支持的认证方法#
- API 访问令牌:适用于任何 GitHub 节点。
- OAuth2:仅适用于 GitHub 和 GitHub Trigger 节点;不要与 GitHub Document Loader 一起使用。
相关资源#
参考 GitHub 的 API 文档了解有关该服务的更多信息。
使用 API 访问令牌#
要配置此凭据,您需要一个 GitHub 账户。
设置此凭据有两个步骤:
有关详细说明,请参考以下部分。
生成个人访问令牌#
推荐的访问令牌类型
n8n 推荐使用个人访问令牌(经典)。GitHub 的细粒度个人访问令牌仍处于测试阶段,无法访问所有端点。
要生成您的个人访问令牌:
- 如果您尚未验证,请使用 GitHub 验证您的邮箱地址。参考验证您的邮箱地址了解更多信息。
- 打开您的 GitHub 个人资料设置。
- 在左侧导航中,选择Developer settings。
- 在左侧导航中,在 Personal access tokens 下,选择 Tokens (classic)。
- 选择 Generate new token > Generate new token (classic)。
- 在 Note 字段中为您的令牌输入描述性名称,如
n8n integration
。 - 选择您希望令牌的 Expiration,或选择 No expiration。
- 为您的令牌选择 Scopes。对于大多数 n8n GitHub 节点,添加
repo
范围。- 没有指定范围的令牌只能访问公共信息。
- 选择 Generate token。
- 复制令牌。
参考创建个人访问令牌(经典)了解更多信息。参考 OAuth 应用程序的范围了解有关 GitHub 范围的更多信息。
设置凭据#
然后,在您的 n8n 凭据中:
- 如果您没有使用 GitHub Enterprise Server,请不要更改 GitHub server URL。
- 如果您正在使用 GitHub Enterprise Server,请更新 GitHub server 以匹配您服务器的 URL。
- 输入您在 GitHub 个人资料中显示的 User 用户名。
- 输入您在上面生成的 Access Token 访问令牌。
使用 OAuth2#
n8n 云服务用户注意事项
云服务用户无需提供连接详细信息。选择连接我的账户通过浏览器进行连接。
如果您正在自托管 n8n,请创建新的 GitHub OAuth 应用程序:
- 打开您的 GitHub 个人资料设置。
- 在左侧导航中,选择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 应用程序文档了解有关授权过程的更多信息。