Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/images/contributing/search-results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ shortTitle: Advanced Security billing

## About licenses for {% data variables.product.prodname_GH_advanced_security %}

{% ifversion billing-auth-and-capture %}

{% data reusables.billing.authorization-charge %}

{% endif %}

{% ifversion fpt %}

{% data reusables.advanced-security.ghas-license-info-for-fpt %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ shortTitle: Billing for GitHub Copilot

## About billing for {% data variables.product.prodname_copilot_short %}

{% ifversion billing-auth-and-capture %}

{% data reusables.billing.authorization-charge %}

{% endif %}

You can set up a {% data variables.product.prodname_copilot %} subscription for your personal account, or for an organization or enterprise.

* **For your personal account**, you can set up a subscription to {% data variables.product.prodname_copilot_for_individuals %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ By default, {% data variables.product.prodname_copilot %} connects to {% data va

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](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."

## 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Configuring your proxy server or firewall for Copilot
intro: 'You should allow certain traffic through your firewall or proxy server for {% data variables.product.prodname_copilot_short %} to work as intended.'
permissions: 'Proxy server maintainers or firewall maintainers'
product: '{% data reusables.gated-features.copilot %}'
versions:
feature: copilot
topics:
- Copilot
shortTitle: Allow Copilot traffic
---

If your company employs security measures like a firewall or proxy server, you should add the following URLs, ports, and protocols to an allowlist to ensure {% data variables.product.prodname_copilot_short %} works as expected:

| Domain and/or URL | Purpose |
| :------------------------------------- | :--------------------------------- |
| `https://github.com/login/*` | Authentication |
| `https://api.github.com/user` | User Management |
| `https://api.github.com/copilot_internal/*` | User Management |
| `https://copilot-telemetry.githubusercontent.com/telemetry` | Telemetry |
| `https://default.exp-tas.com/` | Telemetry |
| `https://copilot-proxy.githubusercontent.com/` | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://origin-tracker.githubusercontent.com` | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://*.githubcopilot.com` | API service for {% data variables.product.prodname_copilot_short %} suggestions |

Depending on the security policies and editors your organization uses, you may need to allowlist additional domains and URLs. For more information on specific editors, see "[Further reading](#further-reading)."

Every user of the proxy server or firewall also needs to configure their own environment to connect to {% data variables.product.prodname_copilot_short %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot)."

## Further reading

* [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network) in the {% data variables.product.prodname_vs %} documentation
* [Install and use {% data variables.product.prodname_vs %} and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server) in the Microsoft documentation
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ topics:
children:
- /managing-the-copilot-subscription-for-your-organization
- /setting-policies-for-copilot-in-your-organization
- /configuring-your-proxy-server-or-firewall-for-copilot
- /managing-access-to-github-copilot-in-your-organization
- /enhancing-copilot-for-your-organization
---
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Control which {% data variables.product.prodname_copilot_short %} features are a

## 3. Set up networking (if necessary)

If your enterprise users connect through an HTTP proxy server or firewall, ensure that [these URLs](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot#urls-to-add-to-an-allowlist) are added to the allowlist for the proxy server or firewall.
If your enterprise users connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."

You may also need to install custom SSL certificates on your users' machines. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot)."
You may also need to install custom SSL certificates on your users' machines. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates)."

## 4. Grant access to organizations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Control which {% data variables.product.prodname_copilot_short %} features are a

## 3. Set up networking (if necessary)

If your organization members connect through an HTTP proxy server or firewall, ensure that [these URLs](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot#urls-to-add-to-an-allowlist) are added to the allowlist for the proxy server or firewall.
If your organization members connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."

You may also need to install custom SSL certificates on your members' machines. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot)."
You may also need to install custom SSL certificates on your members' machines. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#-installing-custom-certificates)."

## 4. Grant access to members

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ If you want to use {% data variables.product.prodname_copilot_short %} in the co

## 4. Set up networking (if necessary)

If you connect through an HTTP proxy server or firewall, ensure that [these URLs](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot#urls-to-add-to-an-allowlist) are added to the allowlist for the proxy server or firewall.
If you connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."

You may also need to install a custom SSL certificate on your machine. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot)."
You may also need to install a custom SSL certificate on your machine. See "[AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates)."

## 5. Configure settings (optional)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,13 @@ topics:
- Networking
versions:
feature: copilot
shortTitle: Firewall settings
shortTitle: Connectivity security settings
---

If you or your organization employs security measures like a firewall or proxy server, it may be beneficial to include certain domain URLs in an "allowlist" and open specific ports and protocols. Doing so will enhance your installation and usage of {% data variables.product.prodname_copilot_short %} for an optimal experience.
## About the problem

## URLs to add to an allowlist
If you or your company uses a firewall, {% data variables.product.prodname_copilot_short %} may not function as expected. {% data variables.product.prodname_copilot_short %} interacts with a remote machine learning model and checks for updates, and a firewall may block important traffic and degrade the user experience.

Due to {% data variables.product.prodname_copilot_short %}'s interaction with a remote machine learning model and its update-checking functionality, it is recommended to include the following domain URLs in the allowlist, marking them as trusted either in the user interface or within your deployment scripts.
## Solving the problem

| Domain and/or URL | Purpose |
| :------------------------------------- | :--------------------------------- |
| `https://github.com/login/*` | Authentication |
| `https://api.github.com/user` | User Management |
| `https://api.github.com/copilot_internal/*` | User Management |
| `https://copilot-telemetry.githubusercontent.com/telemetry` | Telemetry |
| `https://default.exp-tas.com/` | Telemetry |
| `https://copilot-proxy.githubusercontent.com/` | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://origin-tracker.githubusercontent.com` | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://*.githubcopilot.com` | API service for {% data variables.product.prodname_copilot_short %} suggestions |

Additional domains and URLs may require allowlisting, depending on your organization's security policies and the editors in use. For more information about specific editors, see "[Further reading](#further-reading)."

## Further reading

* [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network)
* [Install and use Visual Studio and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server)
* "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)"
For an optimal {% data variables.product.prodname_copilot_short %} experience, you should create an "allowlist" that lets certain URLs, ports, and protocols through your firewall. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If there is a problem with your proxy setup, you may see the following error: `{

If you know you are connecting via a proxy, make sure the proxy is configured correctly in your environment. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#configuring-proxy-settings-for-github-copilot)."

> [!NOTE] If you are an employee of a company with a proxy server, your company must also configure proxy settings for {% data variables.product.prodname_copilot_short %} at the company level. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)."

{% data variables.product.prodname_copilot %} uses custom code to connect to proxies. This means a proxy setup supported by your editor is not necessarily supported by {% data variables.product.prodname_copilot %}. Some common causes for errors related to proxies are:

* If your proxy's URL starts `https://`, it is not currently supported by {% data variables.product.prodname_copilot %}.
Expand Down
6 changes: 1 addition & 5 deletions data/reusables/billing/authorization-charge.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
{% note %}

**Note:** {% data variables.product.company_short %} may apply a temporary authorization hold for the value of the usage-based costs in advance, which will appear as a pending charge in your account's payment method.

{% endnote %}
>[!NOTE] {% data variables.product.company_short %} may apply a temporary authorization hold for the value of the usage-based costs in advance, which will appear as a pending charge in your account's payment method.
61 changes: 59 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"all-documents": "tsx src/content-render/scripts/all-documents/cli.ts",
"analyze-text": "node src/search/scripts/analyze-text.js",
"analyze-comment": "tsx src/events/scripts/analyze-comment-cli.ts",
"archive-version": "node --max-old-space-size=8192 src/ghes-releases/scripts/archive-version.js",
"archive-version": "tsx --max-old-space-size=16384 src/ghes-releases/scripts/archive-version.ts",
"audit-log-sync": "tsx src/audit-logs/scripts/sync.ts",
"build": "next build",
"check-content-type": "node src/workflows/check-content-type.js",
Expand Down Expand Up @@ -58,6 +58,7 @@
"prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"",
"prevent-pushes-to-main": "node src/workflows/prevent-pushes-to-main.js",
"release-banner": "node src/ghes-releases/scripts/release-banner.js",
"reusables": "tsx src/content-render/scripts/reusables-cli.ts",
"remove-version-markup": "node src/ghes-releases/scripts/remove-version-markup.js",
"rendered-content-link-checker": "tsx src/links/scripts/rendered-content-link-checker.ts",
"rendered-content-link-checker-cli": "tsx src/links/scripts/rendered-content-link-checker-cli.ts",
Expand Down Expand Up @@ -339,6 +340,7 @@
"@types/react-dom": "^18.3.0",
"@types/semver": "^7.5.8",
"@types/tcp-port-used": "1.0.4",
"@types/website-scraper": "^1.2.10",
"@typescript-eslint/eslint-plugin": "^7.15.0",
"@typescript-eslint/parser": "^7.16.0",
"chalk": "^5.0.1",
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/lib/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.",
"apiRequestEvent": "This event is only available via audit log streaming."
},
"sha": "2ff6ca1490c05079b409af85320cec5089dc388a"
"sha": "0d0a015e748451e1083bdce44ce19206c4cda4d3"
}
2 changes: 1 addition & 1 deletion src/content-linter/tests/category-pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ describe.skip('category pages', () => {
}

await contextualize(req as ExtendedRequest, res as Response, next)
await shortVersions(req, res, next)
await shortVersions(req as ExtendedRequest, res as Response, next)

// Save the index title for later testing
indexTitle = data.title.includes('{')
Expand Down
2 changes: 1 addition & 1 deletion src/content-render/scripts/all-documents/lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export async function allDocuments(options: Options): Promise<AllDocument[]> {
}

await contextualize(req as ExtendedRequest, res as Response, next)
await shortVersions(req, res, next)
await shortVersions(req as ExtendedRequest, res as Response, next)
req.context.page = page
features(req as any, res as any, next)

Expand Down
Loading