GitHub¶
The GitHub connector is a Palantir-provided driver for GitHub.
To create a new GitHub source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for GitHub-specific configuration and networking. For the complete property reference, see the official GitHub driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
OwnerLogin ↗ |
Recommended | A username used for an individual user account or a login name designated for an organization account. | — |
Schema ↗ |
Recommended | Restricts access to data within the specified schema. | — |
URL ↗ |
Recommended | The base URL for the GitHub environment you are connecting to. | — |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| github.com | Always |
| api.github.com | Always |
中文翻译¶
GitHub¶
GitHub 连接器是一个由 Palantir 提供的驱动程序(Palantir-provided driver)，用于连接 GitHub。
要创建新的 GitHub 数据源，请遵循 Palantir 提供驱动程序的标准设置流程(standard setup flow)，然后使用以下各节进行 GitHub 特定的配置和网络设置。有关完整的属性参考，请参阅官方 GitHub 驱动程序文档(Official GitHub driver documentation)。
配置¶
以下属性为必填或推荐配置。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌用于在已认证的授权用户操作期间维护用户访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端 ID（也称为消费者密钥）。在身份验证过程中，需要使用此 ID 向 OAuth 授权服务器标识应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端密钥。此机密值用于向 OAuth 授权服务器验证应用程序的身份。 | — |
OwnerLogin ↗ |
推荐 | 用于个人用户账户的用户名，或用于组织账户的登录名。 | — |
Schema ↗ |
推荐 | 限制对指定模式(Schema)内数据的访问。 | — |
URL ↗ |
推荐 | 您所连接的 GitHub 环境的基础 URL。 | — |
网络配置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略(egress policy)。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略(agent proxy egress policy)；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理(using an agent as a proxy)。
| 域名 | 必需条件 |
|---|---|
| github.com | 始终需要 |
| api.github.com | 始终需要 |