1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/admin/configuring-settings/configuring-network-settings/configuring-an-outbound-web-proxy-server.md
Rachael Sewell 9d4d6dc4b0 Deprecate ghes 3.10 (#54410)
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2025-02-18 18:37:25 +00:00

4.6 KiB

title, intro, redirect_from, permissions, versions, type, topics, shortTitle
title intro redirect_from permissions versions type topics shortTitle
Configuring an outbound web proxy server A proxy server provides an additional level of security for {% data variables.location.product_location %}.
/enterprise/admin/guides/installation/configuring-a-proxy-server
/enterprise/admin/installation/configuring-an-outbound-web-proxy-server
/enterprise/admin/configuration/configuring-an-outbound-web-proxy-server
/admin/configuration/configuring-an-outbound-web-proxy-server
/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server
Site administrators can configure an outbound web proxy server for a {% data variables.product.prodname_ghe_server %} instance.
ghes
*
how_to
Enterprise
Fundamentals
Infrastructure
Networking
Configure an outbound proxy

About configuration of a proxy for {% data variables.product.prodname_ghe_server %}

When a proxy server is enabled for {% data variables.location.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example http://127.0.0.1:8123.

Note

To connect {% data variables.location.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, your proxy configuration must allow connectivity to github.com and api.github.com. For more information, see AUTOTITLE.

{% data reusables.actions.proxy-considerations %} For more information about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %}, see AUTOTITLE.

Configuring an outbound web proxy server

You can configure an outbound proxy server {% data variables.location.product_location %}, and you can configure exceptions for connections to specific domains.

Your instance validates the hostnames for proxy exclusion using the list of IANA's registered top-level domains (TLDs). For more information, see the list of TLDs on the IANA website.

{% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %}

  1. Under HTTP Proxy Server, type the URL of your proxy server.

  2. Optionally, under HTTP Proxy Exclusion, type any hosts that do not require proxy access, separating hosts with commas. The following rules apply to top-level domains (TLDs) and IP addresses that you exclude from the proxy.

    • When you exclude a TLD, you can exclude all hosts in a domain from requiring proxy access using . as a wildcard prefix, such as .octo-org.tentacle.
    • Your instance validates the hostnames you exclude using the list of IANA's registered TLDs. For more information, see the list of TLDs on the IANA website. If you want to exclude an unregistered TLD, see Excluding additional unregistered TLDs from the proxy.
    • You can exclude a full, valid IPv4 or IPv6 address.
    • You cannot exclude an IPv4 or IPv6 address using a preceding or trailing dot as a wildcard.

{% data reusables.enterprise_management_console.save-settings %}

Excluding additional unregistered TLDs from the proxy

You can configure your instance's proxy settings to exclude unregistered TLDs that aren't specified in the list of TLDs on the IANA website.

When you exclude additional unregistered TLDs, you must use . as a wildcard prefix. If the TLD is tentacle, you must exclude .tentacle. You cannot exclude an unregistered TLD without the preceding ..

{% data reusables.enterprise_installation.ssh-into-instance %}

  1. Enter the following command, replacing COMMA-SEPARATED-TLD-LIST with a comma-separated list of TLDs, each prefixed by a . wildcard.

    ghe-config noproxy.exception-tld-list "COMMA-SEPARATED-TLD-LIST"
    

    For example:

    ghe-config noproxy.exception-tld-list ".example,.internal"
    

{% data reusables.enterprise.apply-configuration %}