configuring-network-settings-for-github-copilot.md

title	shortTitle	intro	product	topics	versions	redirect_from
Configuring network settings for GitHub Copilot	Network settings	You can connect to {% data variables.product.prodname_copilot_short %} through an HTTP proxy and use custom certificates.	{% data reusables.gated-features.copilot %}	Copilot	feature copilot	/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot

{% visualstudio %}

{% data reusables.copilot.vs-for-mac-note %}

{% endvisualstudio %}

Introduction

By default, {% data variables.product.prodname_copilot %} connects to {% data variables.product.prodname_dotcom %}'s server directly from your environment via a secure HTTPS connection. You don't necessarily need to configure any additional network settings to use {% data variables.product.prodname_copilot_short %}.

Some networks use an HTTP proxy server to intercept Internet traffic before sending it to its intended location. Companies often use an HTTP proxy to detect suspicious traffic or restrict the content entering their networks. If you're working on a corporate network, you may need to configure {% data variables.product.prodname_copilot_short %} to connect via an HTTP proxy.

[!NOTE] The administrator of your proxy server or firewall also needs to configure network settings for {% data variables.product.prodname_copilot_short %} to work as expected. See "AUTOTITLE."

Configuring proxy settings for {% data variables.product.prodname_copilot %}

{% data variables.product.prodname_copilot %} supports basic HTTP proxy setups. If you need to authenticate to a proxy, {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If the proxy URL starts https://, the proxy is not currently supported.

You can configure an HTTP proxy for {% data variables.product.prodname_copilot %} in your chosen editor. To view instructions for your editor, use the tabs at the top of this article.

If you don't configure a proxy directly in your editor, {% data variables.product.prodname_copilot %} checks if a proxy URL is set in any of the following environment variables, listed from highest to lowest priority.

• HTTPS_PROXY
• https_proxy
• HTTP_PROXY
• http_proxy

[!NOTE] You can use any of these variables to store the URL of a standard HTTP proxy. In standard usage, the http and https portions of these variables refer to the type of request being made, not the URL of the proxy itself. {% data variables.product.prodname_copilot %} does not follow this convention and uses the URL stored in the variable with the highest priority as the proxy for both HTTP and HTTPS requests.

If you have configured a proxy but are still encountering connection errors, see "AUTOTITLE."

{% jetbrains %}

Configuring a proxy in a JetBrains IDE

1. In your JetBrains IDE, click the File menu (Windows) or the name of the application in the menu bar (macOS), then click Settings.

2. Under Appearance & Behavior, click System Settings and then click HTTP Proxy.

3. Select Manual proxy configuration, and then select HTTP.

4. In the "Host name" field, enter the hostname of your proxy server, and in the "Port number" field, enter the port number of your proxy server.

5. Optionally, to configure {% data variables.product.prodname_copilot_short %} to ignore certificate errors, in the left sidebar, click Tools, click Server Certificates, then select or deselect Accept non-trusted certificates automatically.

   [!WARNING] Ignoring certificate errors can cause security issues and is not recommended.

Basic authentication

{% data variables.product.prodname_copilot %} for JetBrains supports basic authentication. To authenticate, you can select Proxy authentication on the "Manual proxy configuration" page, then enter your credentials.

This stores your credentials as plaintext in your editor's settings. Alternatively, you may prefer to include your credentials in the proxy URL (for example: http://USERNAME:[email protected]:5187/), and then set this URL as one of the supported environment variables listed in "Configuring proxy settings for {% data variables.product.prodname_copilot %}."

{% endjetbrains %}

{% vscode %}

Configuring a proxy in {% data variables.product.prodname_vscode %}

{% data reusables.copilot.vscode-settings %}

1. In the left-side panel of the settings tab, click Application and then select Proxy.

2. In the text box under "Proxy", type the address of your proxy server, for example http://localhost:3128.

3. Optionally, to configure {% data variables.product.prodname_copilot_short %} to ignore certificate errors, under "Proxy Strict SSL", select or deselect the checkbox.

   [!WARNING] Ignoring certificate errors can cause security issues and is not recommended.

Basic authentication

{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vscode_shortname %} supports basic authentication. To authenticate, you can include your credentials in the proxy URL, for example: http://USERNAME:[email protected]:5187/. You can store this URL in your {% data variables.product.prodname_vscode_shortname %} settings or in one of the environment variables listed in "Configuring proxy settings for {% data variables.product.prodname_copilot %}."

{% endvscode %}

{% visualstudio %}

Configuring a proxy in {% data variables.product.prodname_vs %}

{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vs %} reads the proxy settings from Windows. For information about configuring proxy settings on Windows, see the instructions under "To set up a proxy server connection manually" in Use a proxy server in Windows in the Microsoft documentation.

Basic authentication

{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vs %} does not retrieve authentication credentials from the Windows settings. If you need to authenticate to a proxy, you can include your credentials in the proxy URL (for example: http://USERNAME:[email protected]:5187/), then set this URL as one of the supported environment variables listed in "Configuring proxy settings for {% data variables.product.prodname_copilot %}."

{% endvisualstudio %}

Authentication with Kerberos

Kerberos is an authentication protocol that allows users and services to prove their identity to each other. When a user successfully authenticates, an authentication service grants the user a ticket that gives them access to a service for a period of time. Network administrators may prefer Kerberos to basic authentication because it is more secure and doesn't require sending unencrypted credentials.

{% data variables.product.prodname_copilot %} supports authentication to a proxy with Kerberos. To use Kerberos, you must have the appropriate krb5 library for your operating system installed on your machine and an active ticket for the proxy service (either created manually with the kinit command or by another application). You can use the klist command to check if you have a ticket for the proxy service.

Kerberos uses a service principal name (SPN) to uniquely identify a service instance. By default, the SPN is derived from the proxy URL. For example, if the proxy URL is http://proxy.example.com:3128, the SPN is HTTP/proxy.example.com.

If the default SPN isn't correct for your proxy, you can override the SPN in {% data variables.product.prodname_vscode_shortname %} and in JetBrains IDEs. You cannot currently override the default SPN in {% data variables.product.prodname_vs %}. However, you can use the environment variable AGENT_KERBEROS_SERVICE_PRINCIPAL to override the SPN for {% data variables.product.prodname_vs %} and JetBrains IDEs.

{% vscode %}

Overriding the default SPN in {% data variables.product.prodname_vscode_shortname %}

1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).

2. Type settings, then click Preferences: Open User Settings (JSON).

3. In the JSON object, add the following top-level property, replacing YOUR-SPN with the correct SPN for your proxy service.

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

{% endvscode %}

{% jetbrains %}

Overriding the default SPN in JetBrains IDEs

1. In your JetBrains IDE, click the File menu (Windows) or the name of the application in the menu bar (macOS), then click Settings.
2. In the left sidebar, click Languages & Frameworks, then click GitHub Copilot.
3. In the "Advanced" section, in the "Override Kerberos Proxy Service Principal Name" field, type the SPN for your proxy service.

{% endjetbrains %}

Allowing {% data variables.product.prodname_copilot %} to use custom certificates

{% data variables.product.prodname_copilot_short %} can read custom SSL certificates installed on a user's machine. This allows a proxy server to be identified as the intended recipient of {% data variables.product.prodname_copilot_short %}'s secure connection, so network traffic can be inspected. Without a custom certificate, an HTTP proxy can be used to monitor, route, and terminate {% data variables.product.prodname_copilot_short %}'s connection, but not to inspect the contents of the traffic.

{% data variables.product.prodname_copilot_short %} reads certificates from the operating system's trust store. It also reads extra certificates from the file specified by the standard Node.js environment variable NODE_EXTRA_CA_CERTS. For more information, see the Node.js documentation.

{% data variables.product.prodname_copilot_short %} can read certificates regardless of whether a proxy is configured directly on a user's machine. This allows {% data variables.product.prodname_copilot_short %} to support setups such as transparent proxies or Zscaler.

Installing custom certificates

Generally, if you're using company equipment, your company's IT department should have already installed any required certificates on your machine. If you need to install a certificate, see the following instructions.

[!WARNING] Installing a custom certificate is an instruction for your computer to trust the creator of the certificate, potentially allowing the creator to intercept all Internet traffic from your machine. You should be very careful to verify that you are installing the correct certificate.

• For Windows, see Installing the trusted root certificate in the Microsoft documentation.
• For macOS, see Add certificates to a keychain using Keychain Access on Mac in the Keychain Access User Guide.
• For Linux, see Installing a root CA certificate in the trust store in the Ubuntu documentation. Similar instructions should apply to most Linux distributions.

If you have installed a certificate but {% data variables.product.prodname_copilot_short %} isn't detecting it, see "AUTOTITLE."