Skip to content

Latest commit

 

History

History
442 lines (334 loc) · 18.5 KB

File metadata and controls

442 lines (334 loc) · 18.5 KB
title Copilot allowlist reference
intro Learn how to allow certain traffic through your firewall or proxy server for {% data variables.product.prodname_copilot_short %} to work as intended in your organization.
permissions Proxy server maintainers or firewall maintainers
versions
feature
copilot
category
Configure Copilot
redirect_from
/copilot/reference/proxy-server-and-firewall-settings-for-copilot
/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot
/copilot/how-tos/administer/organizations/configuring-your-proxy-server-or-firewall-for-copilot
/copilot/reference/allowlist-reference
contentType reference

If your company employs security measures like a firewall or proxy server, you should add the URLs in this article to an allowlist to ensure {% data variables.product.prodname_copilot_short %} works as expected. Users must be able to authenticate to {% data variables.product.github %} and access the {% data variables.product.prodname_copilot_short %} service on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}.

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.

{% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}

We recommend using the /meta API endpoint to find the domains required to use {% data variables.product.github %} on a restricted network. For more information, see AUTOTITLE.

The following request returns most of the wildcard domains required to authenticate and connect to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}. There are some exceptions for specific services, or if you want to allow traffic only for users with specific {% data variables.product.prodname_copilot_short %} plans.

gh api meta -q '.domains | .website, .copilot'

In addition to these domains, we recommend allowing the apex domain github.com. This is not covered by *.github.com and is not returned by the above query, although it is returned by the API under domains.actions.

Specific required domains

The following table lists specific domains required for {% data variables.product.prodname_copilot_short %}. If you have already allowed the wildcard domains returned by the /meta endpoint, you will have already implicitly allowed most of these domains.

URL Purpose Relevant wildcard in /meta response
https://github.com/login/* Authentication github.com
https://github.githubassets.com Authentication *.githubassets.com
https://avatars.githubusercontent.com Authentication *.githubusercontent.com
https://github.com/copilot/* {% data variables.product.prodname_copilot_short %} on {% data variables.product.github %} github.com
https://github.com/enterprises/YOUR-ENTERPRISE/* Authentication for {% data variables.enterprise.prodname_managed_users %}, only required with {% data variables.product.prodname_emus %} github.com
https://api.github.com/user User Management *.github.com
https://api.github.com/copilot_internal/* User Management *.github.com
https://collector.github.com/* Analytics telemetry *.github.com
https://copilot-telemetry.githubusercontent.com/telemetry {% data variables.product.prodname_copilot_short %} client telemetry *.githubusercontent.com
https://default.exp-tas.com {% data variables.product.prodname_copilot_short %} client experimentation default.exp-tas.com
https://copilot-proxy.githubusercontent.com API service for {% data variables.product.prodname_copilot_short %} suggestions *.githubusercontent.com
https://origin-tracker.githubusercontent.com API service for {% data variables.product.prodname_copilot_short %} suggestions *.githubusercontent.com
https://*.githubcopilot.com/* API service for {% data variables.product.prodname_copilot_short %} suggestions. Allows access to authorized users regardless of {% data variables.product.prodname_copilot_short %} plan. Do not add this URL to your allowlist if you are using subscription-based network routing. For more information on subscription-based network routing, see AUTOTITLE. *.githubcopilot.com
https://*.individual.githubcopilot.com API service for {% data variables.product.prodname_copilot_short %} suggestions. Allows access to authorized users via a {% data variables.copilot.copilot_individuals_short %} plan. Do not add this URL to your allowlist if you are using subscription-based network routing. Not included
https://*.business.githubcopilot.com API service for {% data variables.product.prodname_copilot_short %} suggestions. Allows access to authorized users via a {% data variables.copilot.copilot_business_short %} plan. Do not add this URL to your allowlist if you want to use subscription-based network routing to block users from using {% data variables.copilot.copilot_business_short %} on your network. Not included
https://*.enterprise.githubcopilot.com API service for {% data variables.product.prodname_copilot_short %} suggestions. Allows access to authorized users via a {% data variables.copilot.copilot_enterprise_short %} plan. Do not add this URL to your allowlist if you want to use subscription-based network routing to block users from using {% data variables.copilot.copilot_enterprise_short %} on your network. Not included
https://copilot-reports.github.com {% data variables.product.prodname_copilot_short %} usage metrics report downloads *.github.com
https://copilot-reports-*.b01.azurefd.net {% data variables.product.prodname_copilot_short %} usage metrics report downloads (fallback). Required for fallback scenarios where downloads bypass the custom domain and are served from an Azure Front Door CDN. Not included
https://usagereports*.blob.core.windows.net {% data variables.product.prodname_copilot_short %} usage metrics report downloads (fallback). Required for fallback scenarios where downloads bypass the Azure Front Door CDN and are served directly from Azure Blob Storage. Not included

{% data variables.product.prodname_copilot_short %} on {% data variables.enterprise.data_residency_site %}

If you use {% data variables.enterprise.data_residency %}, your enterprise and {% data variables.product.github %}'s services are hosted on a unique subdomain of {% data variables.enterprise.data_residency_site %}.

  1. Allow access to the following domains, which cover most required services.

    • https://*.SUBDOMAIN.ghe.com
    • https://SUBDOMAIN.ghe.com

    Replace SUBDOMAIN with your enterprise slug.

  2. If you plan to use public code detection, allow access to https://origin-tracker.githubusercontent.com. This is required to check generated code against public code hosted on {% data variables.product.prodname_dotcom_the_website %}. For more information, see AUTOTITLE.

All other domains that are required on {% data variables.product.prodname_dotcom_the_website %} are not required on {% data variables.enterprise.data_residency_site %}. For example:

  • Individual services have a dedicated endpoint on your subdomain (such as https://copilot-proxy.SUBDOMAIN.ghe.com/)
  • Client experimentation is disabled on {% data variables.enterprise.data_residency_site %}, so https://default.exp-tas.com is not required
  • Individual {% data variables.product.prodname_copilot_short %} plans are not available on {% data variables.enterprise.data_residency_site %}, so subscription-based network routing (such as https://*.individual.githubcopilot.com) is not supported

Editor-specific requirements

In addition to the URLs required to connect to {% data variables.product.prodname_copilot_short %}, you must ensure your network rules meet the requirements of the local client (for example, outbound requests to vscode.dev in {% data variables.product.prodname_vscode %}). Find the documentation for your chosen client, for example:

{% data variables.product.prodname_copilot_short %} voice features

Voice features in {% data variables.copilot.copilot_cli %} and the {% data variables.copilot.github_copilot_app %} use Foundry Local to run a speech-to-text model on your machine. To query the model catalog and download models, these features make outbound requests to the following Azure domains. If you want to use voice features behind a firewall or proxy server, add these URLs to your allowlist:

Domain and/or URL Purpose
https://ai.azure.com Model catalog requests
https://api.catalog.azureml.ms Detecting the optimal Azure region for model downloads
https://*.api.azureml.ms Regional model catalog endpoints
https://amlwlrt4*.blob.core.windows.net Model downloads from regional Azure Blob Storage. The amlwlrt4* wildcard matches the regional Azure Blob Storage accounts that Foundry Local voice features use to download models. The specific storage account depends on the Azure region closest to the user.

{% data variables.copilot.copilot_cloud_agent %} recommended allowlist

The {% data variables.copilot.copilot_cloud_agent %} includes a built-in firewall with a recommended allowlist that is enabled by default. The recommended allowlist allows access to:

  • Common operating system package repositories (for example, Debian, Ubuntu, Red Hat).
  • Common container registries (for example, Docker Hub, Azure Container Registry, AWS Elastic Container Registry).
  • Packages registries used by popular programming languages (C#, Dart, Go, Haskell, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Swift).
  • Common certificate authorities (to allow SSL certificates to be validated).
  • Hosts used to download web browsers for the Playwright MCP server.

For more information about configuring the {% data variables.copilot.copilot_cloud_agent %} firewall, see AUTOTITLE.

The allowlist allows access to the following hosts:

Azure Infrastructure: Metadata Service

  • 168.63.129.16

Certificate Authorities: DigiCert

  • crl3.digicert.com
  • crl4.digicert.com
  • ocsp.digicert.com

Certificate Authorities: Symantec

  • ts-crl.ws.symantec.com
  • ts-ocsp.ws.symantec.com
  • s.symcb.com
  • s.symcd.com

Certificate Authorities: GeoTrust

  • crl.geotrust.com
  • ocsp.geotrust.com

Certificate Authorities: Thawte

  • crl.thawte.com
  • ocsp.thawte.com

Certificate Authorities: VeriSign

  • crl.verisign.com
  • ocsp.verisign.com

Certificate Authorities: GlobalSign

  • crl.globalsign.com
  • ocsp.globalsign.com

Certificate Authorities: SSL.com

  • crls.ssl.com
  • ocsp.ssl.com

Certificate Authorities: IdenTrust

  • crl.identrust.com
  • ocsp.identrust.com

Certificate Authorities: Sectigo

  • crl.sectigo.com
  • ocsp.sectigo.com

Certificate Authorities: UserTrust

  • crl.usertrust.com
  • ocsp.usertrust.com

Container Registries: Docker

  • 172.18.0.1
  • ghcr.io
  • registry.hub.docker.com
  • *.docker.io
  • *.docker.com
  • production.cloudflare.docker.com
  • auth.docker.io
  • quay.io
  • mcr.microsoft.com
  • gcr.io
  • public.ecr.aws

GitHub: Content & API

  • *.githubusercontent.com
  • raw.githubusercontent.com
  • objects.githubusercontent.com
  • lfs.github.com
  • github-cloud.githubusercontent.com
  • github-cloud.s3.amazonaws.com
  • codeload.github.com
  • scanning-api.github.com
  • api.mcp.github.com
  • uploads.github.com/copilot/chat/attachments/

GitHub: Actions Artifact Storage

  • productionresultssa0.blob.core.windows.net
  • productionresultssa1.blob.core.windows.net
  • productionresultssa2.blob.core.windows.net
  • productionresultssa3.blob.core.windows.net
  • productionresultssa4.blob.core.windows.net
  • productionresultssa5.blob.core.windows.net
  • productionresultssa6.blob.core.windows.net
  • productionresultssa7.blob.core.windows.net
  • productionresultssa8.blob.core.windows.net
  • productionresultssa9.blob.core.windows.net
  • productionresultssa10.blob.core.windows.net
  • productionresultssa11.blob.core.windows.net
  • productionresultssa12.blob.core.windows.net
  • productionresultssa13.blob.core.windows.net
  • productionresultssa14.blob.core.windows.net
  • productionresultssa15.blob.core.windows.net
  • productionresultssa16.blob.core.windows.net
  • productionresultssa17.blob.core.windows.net
  • productionresultssa18.blob.core.windows.net
  • productionresultssa19.blob.core.windows.net

Programming Languages & Package Managers: C# / .NET

  • nuget.org
  • dist.nuget.org
  • api.nuget.org
  • nuget.pkg.github.com
  • dotnet.microsoft.com
  • pkgs.dev.azure.com
  • builds.dotnet.microsoft.com
  • dotnetcli.blob.core.windows.net
  • nugetregistryv2prod.blob.core.windows.net
  • azuresearch-usnc.nuget.org
  • azuresearch-ussc.nuget.org
  • dc.services.visualstudio.com
  • dot.net
  • download.visualstudio.microsoft.com
  • dotnetcli.azureedge.net
  • ci.dot.net
  • www.microsoft.com
  • oneocsp.microsoft.com
  • www.microsoft.com/pkiops/crl/

Programming Languages & Package Managers: Dart

  • pub.dev
  • pub.dartlang.org
  • storage.googleapis.com/pub-packages/
  • storage.googleapis.com/dart-archive/

Programming Languages & Package Managers: Go

  • go.dev
  • golang.org
  • proxy.golang.org
  • sum.golang.org
  • pkg.go.dev
  • goproxy.io
  • storage.googleapis.com/proxy-golang-org-prod/

Programming Languages & Package Managers: Haskell

  • haskell.org
  • *.hackage.haskell.org
  • get-ghcup.haskell.org
  • downloads.haskell.org

Programming Languages & Package Managers: Java

  • www.java.com
  • jdk.java.net
  • api.adoptium.net
  • adoptium.net
  • search.maven.org
  • maven.apache.org
  • repo.maven.apache.org
  • repo1.maven.org
  • maven.pkg.github.com
  • maven-central.storage-download.googleapis.com
  • maven.google.com
  • maven.oracle.com
  • jcenter.bintray.com
  • oss.sonatype.org
  • repo.spring.io
  • gradle.org
  • services.gradle.org
  • plugins.gradle.org
  • plugins-artifacts.gradle.org
  • repo.grails.org
  • download.eclipse.org
  • download.oracle.com

Programming Languages & Package Managers: Node.js / JavaScript

  • npmjs.org
  • npmjs.com
  • registry.npmjs.com
  • registry.npmjs.org
  • skimdb.npmjs.com
  • npm.pkg.github.com
  • api.npms.io
  • nodejs.org
  • yarnpkg.com
  • registry.yarnpkg.com
  • repo.yarnpkg.com
  • deb.nodesource.com
  • get.pnpm.io
  • bun.sh
  • deno.land
  • registry.bower.io
  • binaries.prisma.sh

Programming Languages & Package Managers: Perl

  • cpan.org
  • www.cpan.org
  • metacpan.org
  • cpan.metacpan.org

Programming Languages & Package Managers: PHP

  • repo.packagist.org
  • packagist.org
  • getcomposer.org

Programming Languages & Package Managers: Python

  • pypi.python.org
  • pypi.org
  • pip.pypa.io
  • *.pythonhosted.org
  • files.pythonhosted.org
  • bootstrap.pypa.io
  • conda.binstar.org
  • conda.anaconda.org
  • binstar.org
  • anaconda.org
  • download.pytorch.org
  • repo.continuum.io
  • repo.anaconda.com

Programming Languages & Package Managers: Ruby

  • rubygems.org
  • api.rubygems.org
  • rubygems.pkg.github.com
  • bundler.rubygems.org
  • gems.rubyforge.org
  • gems.rubyonrails.org
  • index.rubygems.org
  • cache.ruby-lang.org
  • *.rvm.io

Programming Languages & Package Managers: Rust

  • crates.io
  • index.crates.io
  • static.crates.io
  • sh.rustup.rs
  • static.rust-lang.org

Programming Languages & Package Managers: Swift

  • download.swift.org
  • swift.org
  • cocoapods.org
  • cdn.cocoapods.org

Infrastructure & Tools: HashiCorp

  • releases.hashicorp.com
  • apt.releases.hashicorp.com
  • yum.releases.hashicorp.com
  • registry.terraform.io

Infrastructure & Tools: JSON Schema

  • json-schema.org
  • json.schemastore.org

Infrastructure & Tools: Playwright

  • playwright.download.prss.microsoft.com
  • cdn.playwright.dev
  • playwright.azureedge.net
  • playwright-akamai.azureedge.net
  • playwright-verizon.azureedge.net
  • storage.googleapis.com/chrome-for-testing-public

Linux Package Managers: Ubuntu

  • archive.ubuntu.com
  • security.ubuntu.com
  • ppa.launchpad.net
  • keyserver.ubuntu.com
  • azure.archive.ubuntu.com
  • api.snapcraft.io

Linux Package Managers: Debian

  • deb.debian.org
  • security.debian.org
  • keyring.debian.org
  • packages.debian.org
  • debian.map.fastlydns.net
  • apt.llvm.org

Linux Package Managers: Fedora

  • dl.fedoraproject.org
  • mirrors.fedoraproject.org
  • download.fedoraproject.org

Linux Package Managers: CentOS

  • mirror.centos.org
  • vault.centos.org

Linux Package Managers: Alpine

  • dl-cdn.alpinelinux.org
  • pkg.alpinelinux.org

Linux Package Managers: Arch

  • mirror.archlinux.org
  • archlinux.org

Linux Package Managers: SUSE

  • download.opensuse.org

Linux Package Managers: Red Hat

  • cdn.redhat.com

Linux Package Managers: Common Package Sources

  • packagecloud.io
  • packages.cloud.google.com
  • packages.microsoft.com

Other

  • dl.k8s.io
  • pkgs.k8s.io