配置 GitHub Copilot 的网络设置

你可以通过 HTTP 代理连接到 Copilot 并使用自定义证书。

谁可以使用此功能？

GitHub Copilot 个人版或 GitHub Copilot 企业版。

本文内容

注意

GitHub Copilot 目前尚不支持 Visual Studio for Mac。

简介

默认情况下，GitHub Copilot 通过安全的 HTTPS 连接直接从你的环境连接到 GitHub 的服务器。你无需配置任何额外的网络设置即可使用 Copilot。

某些网络使用 HTTP 代理服务器来拦截互联网流量，然后再将其发送到预定的位置。公司通常使用 HTTP 代理来检测可疑流量或限制进入其网络的内容。如果你在公司网络上工作，则可能需要配置 Copilot 通过 HTTP 代理连接。

注意

你的代理服务器或防火墙的管理员也需要配置网络设置，才能使 Copilot 正确运行。请参阅“为 Copilot 配置你的代理服务器或防火墙”。

配置 GitHub Copilot 的代理设置

GitHub Copilot 支持基本的 HTTP 代理设置。如果需要对代理进行身份验证，GitHub Copilot 支持基本身份验证或 Kerberos 身份验证。如果代理 URL 以 https:// 开头，则当前不支持该代理。

你可以在你选择的编辑器中配置 GitHub Copilot 的 HTTP 代理。要查看你编辑器的说明，请使用本文顶部的选项卡。

如果你没有在编辑器中直接配置代理，GitHub Copilot 会检查以下环境变量中是否设置了代理 URL（按优先级从高到低列出）。

  • HTTPS_PROXY
  • https_proxy
  • HTTP_PROXY
  • http_proxy

注意

你可以使用任何这些变量来存储标准 HTTP 代理的 URL。在标准用法中，这些变量的 http 和 https 部分指的是正在进行的请求类型，而不是代理本身的 URL。GitHub Copilot 不遵循此约定，并使用优先级最高的变量中存储的 URL 作为 HTTP 和 HTTPS 请求的代理。

如果你已配置代理但仍然遇到连接错误，请参阅“GitHub Copilot 的网络错误排查”。

在 JetBrains IDE 中配置代理

  1. 在你的 JetBrains IDE 中，单击**文件**菜单（Windows）或菜单栏中的应用程序名称（macOS），然后单击**设置**。

  2. 在**外观和行为**下，单击**系统设置**，然后单击**HTTP 代理**。

  3. 选择**手动代理配置**，然后选择**HTTP**。

  4. 在“主机名”字段中，输入你的代理服务器的主机名，在“端口号”字段中，输入你的代理服务器的端口号。

  5. 可选：要配置 Copilot 以忽略证书错误，请在左侧边栏中单击**工具**，单击**服务器证书**，然后选择或取消选择**自动接受不受信任的证书**。

    警告

    忽略证书错误可能会导致安全问题，因此不建议这样做。

基本身份验证

适用于 JetBrains 的 GitHub Copilot 支持基本身份验证。要进行身份验证，你可以在“手动代理配置”页面上选择**代理身份验证**，然后输入你的凭据。

这会将你的凭据以明文形式存储在编辑器的设置中。或者，你可能更倾向于将你的凭据包含在代理 URL 中（例如：http://USERNAME:[email protected]:5187/），然后将此 URL 设置为“配置 GitHub Copilot 的代理设置”中列出的受支持环境变量之一。

在 Visual Studio Code 中配置代理

  1. 在**文件**菜单中，导航到**首选项**并单击**设置**。

    Screenshot of Visual Studio Code settings.

  2. 在设置选项卡的左侧面板中，单击**应用程序**，然后选择**代理**。

  3. 在“代理”下的文本框中，键入你的代理服务器的地址，例如https://127.0.0.1:3128。

  4. 可选：要配置 Copilot 以忽略证书错误，请在“代理严格 SSL”下选择或取消选择复选框。

    警告

    忽略证书错误可能会导致安全问题，因此不建议这样做。

基本身份验证

适用于 VS Code 的 GitHub Copilot 支持基本身份验证。要进行身份验证，你可以在代理 URL 中包含你的凭据，例如：http://USERNAME:[email protected]:5187/。你可以将此 URL 存储在你的 VS Code 设置中或“配置 GitHub Copilot 的代理设置”中列出的环境变量之一中。

在 Visual Studio 中配置代理

适用于 Visual Studio 的 GitHub Copilot 从 Windows 读取代理设置。有关在 Windows 上配置代理设置的信息，请参阅 Microsoft 文档中“在 Windows 中使用代理服务器”下的“手动设置代理服务器连接”部分中的说明。

基本身份验证

适用于 Visual Studio 的 GitHub Copilot 不从 Windows 设置中检索身份验证凭据。如果需要对代理进行身份验证，你可以在代理 URL 中包含你的凭据（例如：http://USERNAME:[email protected]:5187/），然后将此 URL 设置为“配置 GitHub Copilot 的代理设置”中列出的受支持环境变量之一。

使用 Kerberos 进行身份验证

Kerberos 是一种身份验证协议，允许用户和服务相互证明其身份。当用户成功进行身份验证时，身份验证服务会向用户授予一个票证，允许他们在一段时间内访问服务。网络管理员可能更喜欢 Kerberos 而不是基本身份验证，因为它更安全，并且不需要发送未加密的凭据。

GitHub Copilot 支持使用 Kerberos 对代理进行身份验证。要使用 Kerberos，必须在你的计算机上安装适用于你的操作系统的适当 krb5 库，并为代理服务拥有一个活动票证（可以通过 kinit 命令手动创建，也可以由其他应用程序创建）。你可以使用 klist 命令检查你是否拥有代理服务的票证。

Kerberos 使用服务主体名称 (SPN) 来唯一标识服务实例。默认情况下，SPN 来自代理 URL。例如，如果代理 URL 为 http://proxy.example.com:3128，则 SPN 为 HTTP/proxy.example.com。

如果默认 SPN 不适用于你的代理，则可以在 VS Code 和 JetBrains IDE 中覆盖 SPN。你目前无法在 Visual Studio 中覆盖默认 SPN。但是，你可以使用环境变量 AGENT_KERBEROS_SERVICE_PRINCIPAL 来覆盖 Visual Studio 和 JetBrains IDE 的 SPN。

覆盖 VS Code 中的默认 SPN

  1. 按 Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux) 打开 VS Code 命令面板。

  2. 键入 settings，然后单击**首选项：打开用户设置 (JSON)**。

  3. 在 JSON 对象中，添加以下顶级属性，将 YOUR-SPN 替换为你代理服务的正确 SPN。

    JSON
    "http.proxyKerberosServicePrincipal": "YOUR-SPN",

覆盖 JetBrains IDE 中的默认 SPN

  1. 在你的 JetBrains IDE 中，单击**文件**菜单（Windows）或菜单栏中的应用程序名称（macOS），然后单击**设置**。
  2. 在左侧边栏中，单击**语言和框架**，然后单击**GitHub Copilot**。
  3. 在“高级”部分的“覆盖 Kerberos 代理服务主体名称”字段中，键入你的代理服务的 SPN。

允许 GitHub Copilot 使用自定义证书

Copilot 可以读取安装在用户计算机上的自定义 SSL 证书。这允许将代理服务器标识为 Copilot 安全连接的预期接收者，以便可以检查网络流量。如果没有自定义证书，可以使用 HTTP 代理来监控、路由和终止 Copilot 的连接，但不能检查流量的内容。

Copilot 从操作系统的信任存储中读取证书。它还从标准 Node.js 环境变量 NODE_EXTRA_CA_CERTS 指定的文件中读取额外的证书。有关更多信息，请参阅Node.js 文档。

无论是否在用户的计算机上直接配置代理，Copilot 都可以读取证书。这允许 Copilot 支持诸如透明代理或 Zscaler 之类的设置。

安装自定义证书

通常，如果你使用的是公司设备，你的公司 IT 部门应该已经在你计算机上安装了所有必需的证书。如果需要安装证书，请参阅以下说明。

警告

安装自定义证书是指示你的计算机信任证书创建者的指令，这可能会允许创建者拦截来自你计算机的所有互联网流量。你应该非常小心地验证你是否正在安装正确的证书。

如果您已安装证书但 Copilot 无法检测到，请参阅“GitHub Copilot 网络错误排查”。