GitHub 凭据#
您可以使用此凭据验证以下节点:
- GitHub
- GitHub 触发器
- GitHub 文档加载器:此节点不支持 OAuth 认证
前置要求#
创建 GitHub 账户
支持的认证方式#
- API 访问令牌:此方法适用于所有 GitHub 节点
- OAuth2:此方法仅适用于 GitHub 和 GitHub 触发器 节点,不可用于 GitHub 文档加载器
相关资源#
有关该服务的更多信息,请参阅 GitHub API 文档
使用 API 访问令牌#
配置此凭据需要拥有 GitHub 账户
设置此凭据包含两个步骤:
详细说明请参考以下章节
生成个人访问令牌#
推荐访问令牌类型
n8n 建议使用个人访问令牌(经典版)。GitHub 的细粒度个人访问令牌仍处于测试阶段,无法访问所有端点
生成个人访问令牌:
- 如未完成,请先通过 GitHub 验证您的邮箱地址。详细信息请参考验证邮箱地址
- 打开 GitHub 个人资料设置
- 在左侧导航栏选择开发者设置
- 在左侧导航栏的 个人访问令牌 下选择 令牌(经典版)
- 选择 生成新令牌 > 生成新令牌(经典版)
- 在 备注 字段输入令牌描述性名称,例如
n8n integration - 选择令牌的 过期时间,或选择 永不过期
- 选择令牌的 作用域。对于大多数 n8n GitHub 节点,需添加
repo作用域- 未分配作用域的令牌仅能访问公开信息
- 选择 生成令牌
- 复制生成的令牌
更多信息请参考创建个人访问令牌(经典版)。有关 GitHub 作用域的详细信息,请参阅 OAuth 应用作用域
设置凭据#
在 n8n 凭据中:
- 如未使用 GitHub Enterprise Server,请勿更改 GitHub 服务器 URL
- 如使用 GitHub Enterprise Server,请将 GitHub 服务器 更新为您的服务器 URL
- 输入您在 GitHub 个人资料中显示的 用户 名
- 输入您生成的 访问令牌
使用 OAuth2#
n8n 云用户须知
云用户无需提供连接详情。选择 连接我的账户 通过浏览器进行连接
如您正在自托管 n8n,请创建新的 GitHub OAuth 应用:
- 打开 GitHub 个人资料设置
- 在左侧导航栏选择开发者设置
- 在左侧导航栏选择 OAuth 应用
- 选择 新建 OAuth 应用
- 如未创建过应用,可能会显示 注册新应用,请选择该选项
- 输入 应用名称,例如
n8n integration - 输入应用网站的 主页 URL
- 可选:添加 应用描述,该信息将显示给终端用户
- 从 n8n 复制 OAuth 重定向 URL 并粘贴到 GitHub 的 授权回调 URL 中
- 选择 注册应用
- 复制生成的 客户端 ID 和 客户端密钥 并添加到 n8n 凭据中
有关授权流程的更多信息,请参阅 GitHub OAuth 应用授权文档