Skip to content

Commit 9085be8

Browse files
authored
Merge pull request #39389 from github/repo-sync
Repo sync
2 parents 5a28246 + 7641ff8 commit 9085be8

8 files changed

+227
-165
lines changed

content/copilot/concepts/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@ children:
1919
- /policies
2020
- /copilot-knowledge-bases
2121
- /build-copilot-extensions
22+
- /network-settings-for-github-copilot
2223
---
2324

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Network settings for GitHub Copilot
3+
shortTitle: Network settings
4+
intro: 'You can connect to {% data variables.product.prodname_copilot %} through an HTTP proxy and use custom certificates.'
5+
versions:
6+
fpt: '*'
7+
ghec: '*'
8+
topics:
9+
- Copilot
10+
---
11+
12+
The network settings for {% data variables.product.prodname_copilot %} allow you to connect to {% data variables.product.prodname_dotcom %} through an HTTP proxy and use custom certificates.
13+
14+
## Proxy settings for {% data variables.product.prodname_copilot_short %}
15+
16+
By default, {% data variables.product.prodname_copilot_short %} 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 %}.
17+
18+
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.
19+
20+
> [!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](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot).
21+
22+
{% data variables.product.prodname_copilot_short %} supports basic HTTP proxy setups. If you need to authenticate to a proxy, {% data variables.product.prodname_copilot_short %} supports basic authentication or authentication with Kerberos. If the proxy URL starts `https://`, the proxy is not currently supported.
23+
24+
If you don't configure a proxy directly in your editor, {% data variables.product.prodname_copilot_short %} checks if a proxy URL is set in any of the following environment variables, listed from highest to lowest priority.
25+
26+
* `HTTPS_PROXY`
27+
* `https_proxy`
28+
* `HTTP_PROXY`
29+
* `http_proxy`
30+
31+
> [!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_short %} 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.
32+
33+
### Authentication with Kerberos
34+
35+
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.
36+
37+
{% 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.
38+
39+
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`.
40+
41+
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_vscode_shortname %} and JetBrains IDEs.
42+
43+
## Custom certificates
44+
45+
{% 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.
46+
47+
{% 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](https://nodejs.org/docs/latest-v18.x/api/cli.html#node_extra_ca_certsfile).
48+
49+
{% 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.
50+
51+
## Next steps
52+
53+
To learn how to configure network settings in your editor, see [AUTOTITLE](/copilot/how-tos/personal-settings/configuring-network-settings-for-github-copilot).

content/copilot/how-tos/personal-settings/configuring-github-copilot-in-your-environment.md

Lines changed: 14 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,6 @@ If you use a JetBrains IDE, {% data variables.product.prodname_copilot %} can he
2525

2626
To configure {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains).
2727

28-
## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %}
29-
30-
You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command. For more information on rebinding keyboard shortcuts in your JetBrains IDE, see the JetBrains documentation. For example, you can view the [IntelliJ IDEA](https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html#choose-keymap) documentation.
31-
32-
### Keyboard shortcuts for macOS
33-
34-
| Action | Shortcut |
35-
|:---|:---|
36-
|Accept an inline suggestion|<kbd>Tab</kbd>|
37-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
38-
|Show next inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>]</kbd>|
39-
|Show previous inline suggestion|<kbd>Option (⌥) or Alt</kbd>+<kbd>[</kbd>|
40-
|Trigger inline suggestion|<kbd>Option (⌥)</kbd>+<kbd>\\</kbd>|
41-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Option (⌥) or Alt</kbd>+<kbd>Return</kbd> |
42-
43-
### Keyboard shortcuts for Windows
44-
45-
| Action | Shortcut |
46-
|:---|:---|
47-
|Accept an inline suggestion|<kbd>Tab</kbd>|
48-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
49-
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd>|
50-
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|
51-
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\\</kbd>|
52-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Alt</kbd>+<kbd>Enter</kbd> |
53-
54-
### Keyboard shortcuts for Linux
55-
56-
| Action | Shortcut |
57-
|:---|:---|
58-
|Accept an inline suggestion|<kbd>Tab</kbd>|
59-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|
60-
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd>|
61-
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|
62-
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\\</kbd>|
63-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Alt</kbd>+<kbd>Enter</kbd> |
64-
6528
## Enabling or disabling {% data variables.product.prodname_copilot %}
6629

6730
You can enable or disable {% data variables.product.prodname_copilot %} from within your JetBrains IDE. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the JetBrains window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.
@@ -74,6 +37,12 @@ You can enable or disable {% data variables.product.prodname_copilot %} from wit
7437

7538
![Screenshot of the menu to disable {% data variables.product.prodname_copilot %} globally or for the current language in a JetBrains IDE.](/assets/images/help/copilot/disable-copilot-global-or-language-jetbrains.png)
7639

40+
## Rebinding keyboard shortcuts
41+
42+
You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using {% data variables.product.prodname_copilot %}. For a list of default keyboard shortcuts, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts-for-github-copilot-in-the-ide).
43+
44+
Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command. For more information on rebinding keyboard shortcuts in your JetBrains IDE, see the JetBrains documentation. For example, you can view the [IntelliJ IDEA](https://www.jetbrains.com/help/idea/mastering-keyboard-shortcuts.html#choose-keymap) documentation.
45+
7746
## Configuring advanced settings for {% data variables.product.prodname_copilot %}
7847

7948
You can manage advanced settings for {% data variables.product.prodname_copilot %} in your JetBrains IDE, such as how your IDE displays code completions, and which languages you want to enable or disable for {% data variables.product.prodname_copilot %}.
@@ -203,18 +172,9 @@ If you use {% data variables.product.prodname_vs %}, {% data variables.product.p
203172

204173
To configure {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=visualstudio).
205174

206-
## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %}
207-
208-
You can use the default keyboard shortcuts in {% data variables.product.prodname_vs %} when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts in the Tools settings for {% data variables.product.prodname_vs %} using your preferred keyboard shortcuts for each specific command. You can search for each keyboard shortcut by its command name in the Keyboard Shortcuts editor.
209-
210-
### Using default keyboard shortcuts
211-
212-
| Action | Shortcut | Command name |
213-
|:---|:---|:---|
214-
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>.</kbd>|Edit.NextSuggestion|
215-
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>,</kbd>|Edit.PreviousSuggestion|
175+
## Rebinding keyboard shortcuts
216176

217-
### Rebinding keyboard shortcuts
177+
You can use the default keyboard shortcuts for inline suggestions in {% data variables.product.prodname_vs %} when using {% data variables.product.prodname_copilot %}. For a list of default keyboard shortcuts, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts-for-github-copilot-in-the-ide).
218178

219179
If you don't want to use the default keyboard shortcuts in {% data variables.product.prodname_vs %} when using {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Keyboard editor using your preferred keyboard shortcuts for each specific command.
220180

@@ -265,47 +225,11 @@ If you use {% data variables.product.prodname_vscode %}, {% data variables.produ
265225

266226
You can learn more about scenarios and setup in the [{% data variables.product.prodname_vscode_shortname %} documentation](https://code.visualstudio.com/docs/copilot/overview#_use-cases-for-github-copilot-in-vs-code).
267227

268-
## Keyboard shortcuts for {% data variables.product.prodname_copilot %}
269-
270-
You can use the default keyboard shortcuts for {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_copilot %}. Search keyboard shortcuts by command name in the Keyboard Shortcuts editor.
271-
272-
Alternatively, you can rebind the shortcut for each command in the Keyboard Shortcuts editor. For more information, see the [VS Code documentation on editing shortcuts](https://code.visualstudio.com/Docs/editor/keybindings).
273-
274-
### Keyboard shortcuts for macOS
275-
276-
| Action | Shortcut | Command name |
277-
|:---|:---|:---|
278-
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
279-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
280-
|Show next inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>]</kbd><br> |editor.action.inlineSuggest.showNext|
281-
|Show previous inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>[</kbd><br> |editor.action.inlineSuggest.showPrevious|
282-
|Trigger inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>\\</kbd><br> |editor.action.inlineSuggest.trigger|
283-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Return</kbd>|github.copilot.generate|
284-
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
285-
286-
### Keyboard shortcuts for Windows
287-
288-
| Action | Shortcut | Command name |
289-
|:---|:---|:---|
290-
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
291-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
292-
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
293-
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|editor.action.inlineSuggest.showPrevious|
294-
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\\</kbd>|editor.action.inlineSuggest.trigger|
295-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
296-
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
228+
## Rebinding keyboard shortcuts
297229

298-
### Keyboard shortcuts for Linux
230+
You can use the default keyboard shortcuts for inline suggestions in {% data variables.product.prodname_vscode_shortname %} when using {% data variables.product.prodname_copilot %}. Search keyboard shortcuts by command name in the Keyboard Shortcuts editor. For a list of default keyboard shortcuts, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts-for-github-copilot-in-the-ide).
299231

300-
| Action | Shortcut | Command name |
301-
|:---|:---|:---|
302-
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
303-
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
304-
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
305-
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|editor.action.inlineSuggest.showPrevious|
306-
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\\</kbd>|editor.action.inlineSuggest.trigger|
307-
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
308-
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
232+
Alternatively, you can rebind the shortcut for each command in the Keyboard Shortcuts editor. For more information, see the [{% data variables.product.prodname_vscode %} documentation on editing shortcuts](https://code.visualstudio.com/Docs/editor/keybindings).
309233

310234
{% data reusables.copilot.enabling-or-disabling-in-vsc %}
311235

@@ -402,19 +326,9 @@ If you use Xcode, {% data variables.product.prodname_copilot %} can help you wit
402326

403327
To configure {% data variables.product.prodname_copilot %} for Xcode, you must install the {% data variables.product.prodname_copilot %} extension. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=xcode).
404328

405-
## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %}
406-
407-
You can use the default keyboard shortcuts for inline suggestions in Xcode when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command.
408-
409-
### Default keyboard shortcuts
410-
411-
| Action | Shortcut |
412-
|:---|:---|
413-
|Accept the first line of a suggestion|<kbd>Tab</kbd>|
414-
|View full suggestion|Hold <kbd>Option</kbd>|
415-
|Accept full suggestion|<kbd>Option</kbd>+<kbd>Tab</kbd>|
329+
## Rebinding keyboard shortcuts
416330

417-
### Rebinding keyboard shortcuts
331+
You can use the default keyboard shortcuts for inline suggestions in Xcode when using {% data variables.product.prodname_copilot %}. For a list of default keyboard shortcuts, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts-for-github-copilot-in-the-ide).
418332

419333
If you don't want to use the default keyboard shortcuts for {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Key Bindings editor and use your preferred keyboard shortcuts.
420334

@@ -456,13 +370,9 @@ After you install {% data variables.product.prodname_copilot %} in Eclipse, you
456370

457371
To configure {% data variables.product.prodname_copilot %} in Eclipse, you must install the {% data variables.product.prodname_copilot %} extension. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=eclipse).
458372

459-
## Using or rebinding keyboard shortcuts for {% data variables.product.prodname_copilot %}
460-
461-
You can use the default keyboard shortcuts for inline suggestions in Eclipse when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts to your preferred keyboard shortcuts for each specific command.
462-
463373
## Rebinding keyboard shortcuts
464374

465-
If you don't want to use the default keyboard shortcuts for {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Key Bindings editor and use your preferred keyboard shortcuts.
375+
If you don't want to use the default keyboard shortcuts for {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Key Bindings editor and use your preferred keyboard shortcuts. For a list of default keyboard shortcuts, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts-for-github-copilot-in-the-ide).
466376

467377
1. In the IDE, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** to open the menu.
468378
1. Click **Edit Keyboard Shortcuts...** to rebind the shortcuts.

0 commit comments

Comments
 (0)