text stringlengths 12 91.7k | metadata dict |
|---|---|
How should I use the setup user?
The setup user is an administrative account. It is only intended to be used for:
Configuring authentication and provisioning
SCIM provisioning via its
Regaining access to your enterprise in the event of an issue with your identity provider
For other enterprise administration tasks, ... | {
"source": "github-docs/admin/concepts/identity-and-access-management/setup-user.md",
"title": "Setup user"
} |
How should I offboard users?
The method for offboarding a user depends on your enterprise type:
Personal accounts: Remove the user from the enterprise account using the UI or API.
Outside collaborators are an exception to this process. They cannot be removed in the enterprise settings, and must be removed from eac... | {
"source": "github-docs/admin/concepts/identity-and-access-management/user-offboarding.md",
"title": "About user offboarding on {% data variables.product.prodname_ghe_cloud %}"
} |
What are audit logs?
[!NOTE]
Site administrators can review the audit log for an instance, which contains a wider range of events including system administrative events. To access the instance-level audit log:
1. In the left menu, click Audit log.
In addition to viewing your audit log, you can monitor activity in your... | {
"source": "github-docs/admin/concepts/security-and-compliance/audit-log-for-an-enterprise.md",
"title": "Audit log for an enterprise"
} |
What are enterprise policies and why are they important?
To help you enforce business rules and regulatory compliance, policies provide a single point of management for all the organizations owned by an enterprise account.
For example, with the "Base permissions" policy, you can allow organization owners to configure t... | {
"source": "github-docs/admin/concepts/security-and-compliance/enterprise-policies.md",
"title": "Enterprise policies"
} |
About package ecosystem support
You can choose which package ecosystems you'd like to enable, disable, or set to read-only on .
Prerequisites
Before you can configure individual package ecosystems, must be enabled and configured for your instance. For more information, see AUTOTITLE.
Enabling or disabling individua... | {
"source": "github-docs/admin/configuring-packages/configuring-package-ecosystem-support-for-your-enterprise.md",
"title": "Configuring package ecosystem support for your enterprise"
} |
[!WARNING]
It is critical that you configure any restrictive access policies you need for your storage bucket, because does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be acc... | {
"source": "github-docs/admin/configuring-packages/enabling-github-packages-with-aws.md",
"title": "Enabling GitHub Packages with AWS"
} |
[!WARNING]
It is critical that you set the restrictive access policies you need for your storage bucket, because does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessibl... | {
"source": "github-docs/admin/configuring-packages/enabling-github-packages-with-azure-blob-storage.md",
"title": "Enabling GitHub Packages with Azure Blob Storage"
} |
[!WARNING]
It is critical that you set the restrictive access policies you need for your storage bucket, because does not apply specific object permissions or additional access control lists (ACLs) to your storage bucket configuration. For example, if you make your bucket public, data in the bucket will be accessibl... | {
"source": "github-docs/admin/configuring-packages/enabling-github-packages-with-minio.md",
"title": "Enabling GitHub Packages with MinIO"
} |
Step 1: Check whether is available for your enterprise
is available in 3.0 or higher. If you're using an earlier version of , you'll have to upgrade to use . For more information about upgrading your instance, see AUTOTITLE.
Step 2: Review hardware requirements
If you plan to enable for the users of your instance... | {
"source": "github-docs/admin/configuring-packages/getting-started-with-github-packages-for-your-enterprise.md",
"title": "Getting started with GitHub Packages for your enterprise"
} |
Supported external storage providers
Amazon Web Services (AWS) S3
Azure Blob Storage
MinIO
To enable and configure third-party storage, see:
AUTOTITLE
AUTOTITLE
AUTOTITLE
Step 4: Specify the package ecosystems to support on your instance
Choose which package ecosystems you'd like to enable, disable, or set to r... | {
"source": "github-docs/admin/configuring-packages/getting-started-with-github-packages-for-your-enterprise.md",
"title": "Getting started with GitHub Packages for your enterprise"
} |
About the
For more information, see AUTOTITLE.
For more information about configuring for , see AUTOTITLE.
About migration from the Docker registry
If the Docker registry on contains images, you must manually migrate the images to the .
[!NOTE]
For more information about the impact of migration to the , see AUT... | {
"source": "github-docs/admin/configuring-packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry.md",
"title": "Migrating your enterprise to the Container registry from the Docker registry"
} |
allows to connect to your enterprise on in limited ways.
After you enable , you can choose which features to enable. For example, you can:
Automatically sync license usage between environments
Unify search results and user contribution data
Enable features that rely on , such as for security vulnerabilities that ... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/about-github-connect.md",
"title": "About GitHub Connect"
} |
When you disconnect from , the is deleted from your enterprise account and credentials stored on are deleted.
1. Under "", to the right of the enterprise account you'd like to disconnect, click Disable .
1. Read the information about disconnection, then click Disable . | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/disabling-github-connect.md",
"title": "Disabling GitHub Connect"
} |
About automatic license synchronization
For more information, see AUTOTITLE.
If you enable automatic user license sync for your enterprise, every week, will automatically synchronize license usage between and your enterprise on or . You can also synchronize your license data at any time outside of the automatic wee... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md",
"title": "Enabling automatic user license sync for your enterprise"
} |
About for
helps users find and fix vulnerabilities in their dependencies. You must first set up for your enterprise, and then you can enable to notify users about vulnerable dependencies and to fix the vulnerabilities and keep dependencies updated to the latest version.
is just one of many features available to ... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-dependabot-for-your-enterprise.md",
"title": "Enabling Dependabot for your enterprise"
} |
You can access additional features and workflows on by enabling . See AUTOTITLE.
What happens when is enabled?
Prerequisites
Administrative access: You need administrative access to both an enterprise account on and a instance.
Version requirement: Your instance must run 3.12 or later.
Proxy configuration: I... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom.md",
"title": "Enabling GitHub Connect for GHE.com"
} |
You can access additional features and workflows on by enabling . See AUTOTITLE.
What happens when is enabled?
Prerequisites
You must have an enterprise account on that uses .
Your enterprise account on must be invoiced. Enterprise accounts on the free trial of or that pay by credit card cannot be connected to... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom.md",
"title": "Enabling GitHub Connect for GitHub.com"
} |
About
collects aggregate usage data from , which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from .
only collects certain aggregate metrics on repositories, issues, pull requests, and other features. content, such as code, issues, comme... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md",
"title": "Enabling Server Statistics for your enterprise"
} |
About unified contributions
As an enterprise owner, you can allow end users to send anonymized contribution counts for their work from to their contribution graph on or .
After you enable , before individual users can send contribution counts from to , each user must also connect their user account on with an accou... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-unified-contributions-for-your-enterprise.md",
"title": "Enabling unified contributions for your enterprise"
} |
About
When you enable unified search, users can view search results from content on or when searching from .
You can choose to allow search results for public repositories on , and you can separately choose to allow search results for private repositories on . If you enable unified search for private repositories, u... | {
"source": "github-docs/admin/configuring-settings/configuring-github-connect/enabling-unified-search-for-your-enterprise.md",
"title": "Enabling unified search for your enterprise"
} |
About changes to the hostname for
If you need to use a new hostname for , you must back up the existing instance's settings and data, configure a new instance, restore the backup to the new instance, and then adjust your DNS configuration to send traffic to the new instance.
Migration to a new instance requires downti... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/changing-the-hostname-for-your-instance.md",
"title": "Changing the hostname for your instance"
} |
About configuration of a proxy for
When a proxy server is enabled for , outbound messages sent by 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 se... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-an-outbound-web-proxy-server.md",
"title": "Configuring an outbound web proxy server"
} |
About 's firewall
uses Ubuntu's Uncomplicated Firewall (UFW) on the virtual appliance. For more information see Firewall in the Ubuntu documentation. automatically updates the firewall allowlist of allowed services with each release.
After you install , all required network ports are automatically opened to accept co... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-built-in-firewall-rules.md",
"title": "Configuring built-in firewall rules"
} |
The nameservers you specify must resolve 's hostname.
Configuring nameservers using the virtual machine console
1. Configure nameservers for your instance.
Configuring nameservers using the administrative shell
1. To edit your nameservers, use the ghe-setup-network command in visual mode. For more information, see AU... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-dns-nameservers.md",
"title": "Configuring DNS nameservers"
} |
About the hostname for
To provide reliable access to via a known name on the network, you can configure a hostname. If you configure a hostname instead of using a hard-coded IP address, you will be able to change the physical hardware that runs on without affecting users or client software.
The hostname setting in t... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-the-hostname-for-your-instance.md",
"title": "Configuring the hostname for your instance"
} |
[!NOTE]
We do not support adding additional network adapters to .
1. Choose to configure the IPv4 or IPv6 protocol.
1. Configure options for the protocol you chose. | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-the-ip-address-using-the-virtual-machine-console.md",
"title": "Configuring the IP address using the virtual machine console"
} |
Default NTP servers
We recommend configuring your own preferred NTP servers. The default NTP server values on GitHub Enterprise Server are the following:
AWS
Primary Server: 169.254.169.123 prefer iburst minpoll 4 maxpoll 4
NTP Pool: time.aws.com iburst
Other (non-AWS)
Primary Server: 0.github.pool.ntp.org
Secondar... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/configuring-time-synchronization.md",
"title": "Configuring time synchronization"
} |
Administrative ports
Some administrative ports are required to configure and run certain features. Administrative ports are not required for basic application use by end users.
Port Service Description
---------
8443 HTTPS Secure web-based . Required for basic installation and configuration.
8080 HTTP Plain... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/network-ports.md",
"title": "Network ports"
} |
About load balancers
Handling client connection information
Because client connections to come from the load balancer, the client IP address can be lost.
Enabling PROXY protocol support on
We strongly recommend enabling PROXY protocol support for both your instance and the load balancer. Use the instructions provid... | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md",
"title": "Using GitHub Enterprise Server with a load balancer"
} |
1. To test your appliance's DNS and SSL settings, under "Hostname", click Test domain settings. | {
"source": "github-docs/admin/configuring-settings/configuring-network-settings/validating-your-domain-settings.md",
"title": "Validating your domain settings"
} |
About Azure private networking for -hosted runners
About using larger runners with Azure VNET
About network communication
About supported regions
About the service permissions
Using your VNET's network policies
About VNET failover
For more information about configuring a failover network, see AUTOTITLE.
Managin... | {
"source": "github-docs/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise.md",
"title": "About Azure private networking for GitHub-hosted runners in your enterprise"
} |
About network configurations
About Azure private networking for -hosted runners
For more information about using -hosted runners with an Azure VNET, see AUTOTITLE. | {
"source": "github-docs/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-networking-for-hosted-compute-products-in-your-enterprise.md",
"title": "About networking for hosted compute products in your enterprise"
} |
About Azure private networking for -hosted runners
Configuring your Azure resources
1. Obtain the databaseId for your enterprise
[!TIP]
Your token will require at minimum read:enterprise permissions to perform a successful query.
You can use the following GraphQL query to retrieve your enterprise databaseId. You wi... | {
"source": "github-docs/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md",
"title": "Configuring private networking for GitHub-hosted runners in your enterprise"
} |
Variables
{
"slug": "ENTERPRISE_SLUG"
}
Example for
You can use the following curl command to find your databaseId.
curl -H "Authorization: Bearer BEARER_TOKEN" -X POST \
-d '{ "query": "query($slug: String!) { enterprise (slug: $slug) { slug databaseId } }" ,
"variables": {
"slug": "ENTERPRISE_... | {
"source": "github-docs/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md",
"title": "Configuring private networking for GitHub-hosted runners in your enterprise"
} |
Troubleshooting configuring private networking for -hosted runners in your enterprise | {
"source": "github-docs/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-enterprise.md",
"title": "Troubleshooting Azure private network configurations for GitHub-hosted runners in your enter... |
About a data-driven approach to rate limits
Without rate limits, a single CI integration making tens of thousands of requests per hour can slow down your entire instance for every user. But setting limits too aggressively can break the integrations your teams rely on. A data-driven approach helps you find the right bal... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/best-practices-for-configuring-api-rate-limits.md",
"title": "Best practices for configuring API rate limits"
} |
Adjusting image caching
You can choose the amount of time that caches avatars. When you increase the cache time, you increase the amount of time a user's avatar will take to load. Configuring the cache time with too low a value can overload work processes.
1. In the "Settings" sidebar, click Applications.
1. Under "A... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-applications.md",
"title": "Configuring applications"
} |
Configuring SMTP for your enterprise
1. Select Enable email. This will enable both outbound and inbound email. However, for inbound email to work you will also need to configure your DNS settings as described below in [Configuring DNS and firewall
settings to allow incoming emails](configuring-dns-and-firewall-settings... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md",
"title": "Configuring email for notifications"
} |
TLS connection started
<- "EHLO yourdomain.com\r\n"
-> "250-smtp.yourdomain.com at your service, [1.2.3.4]\r\n"
-> "250-SIZE 35882577\r\n"
-> "250-8BITMIME\r\n"
-> "250-AUTH LOGIN PLAIN XOAUTH\r\n"
-> "250-ENHANCEDSTATUSCODES\r\n"
-> "250 PIPELINING\r\n"
<- "AUTH LOGIN\r\n"
-> "334 VXNlcm5hbWU6\r\n"
<- "dGhpc2lzbXlAYWR... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md",
"title": "Configuring email for notifications"
} |
Enabling public sites for
If private mode is enabled on your enterprise, the public cannot access sites hosted by your enterprise unless you enable public sites.
[!WARNING]
If you enable public sites for , every site in every repository on your enterprise will be accessible to the public.
1. Select Public Pages.
D... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-github-pages-for-your-enterprise.md",
"title": "Configuring GitHub Pages for your enterprise"
} |
About interactive maps
You can allow users of to create interactive maps using GeoJSON or TopoJSON syntax. For more information about creation of interactive maps, see AUTOTITLE.
To enable interactive maps, you must provide authentication credentials for Azure Maps.
Prerequisites
To configure interactive maps for yo... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-interactive-maps.md",
"title": "Configuring interactive maps"
} |
About rate limits for
Rate limits help prevent excessive resource use on that could affect availability or performance for all users. You can configure rate limits for the and .
Implement rate limits carefully and communicate with your users as you tune them. Start with permissive rate limits and gradually adjust th... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits.md",
"title": "Configuring rate limits"
} |
About web commit signing
If you enable web commit signing, will automatically use GPG to sign commits users make on the web interface of . Commits signed by will have a verified status. For more information, see AUTOTITLE.
You can enable web commit signing, rotate the private key used for web commit signing, and disa... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-web-commit-signing.md",
"title": "Configuring web commit signing"
} |
About persistent commit verification
When persistent commit verification is enabled, stores a verification record alongside each commit when its signature is verified. This record ensures that verified commits maintain their verification status even if signing keys are later rotated, expired, or revoked. For more info... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/disabling-persistent-commit-verification.md",
"title": "Disabling persistent commit verification"
} |
About
allows people to triage, collaborate, and manage work on from a mobile device after successful authentication. For more information, see AUTOTITLE.
You can allow or disallow people from using to authenticate to and access your instance's data. By default, is enabled for people who use .
Enabling or disabl... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/managing-github-mobile-for-your-enterprise.md",
"title": "Managing GitHub Mobile for your enterprise"
} |
About verification of domains
You can confirm that the websites and email addresses listed on the profiles of any organization owned by your enterprise account are controlled by your enterprise by verifying the domains. Verified domains for an enterprise account apply to every organization owned by the enterprise accou... | {
"source": "github-docs/admin/configuring-settings/configuring-user-applications-for-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md",
"title": "Verifying or approving a domain for your enterprise"
} |
About host keys for your instance
Servers that accept SSH connections advertise one or more cryptographic host keys to securely identify the server to SSH clients. To confirm the server's identity during the initialization of a connection, clients store and verify the host key. For more information, see SSH Host Key - ... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-host-keys-for-your-instance.md",
"title": "Configuring host keys for your instance"
} |
About SSH connections to your instance
To accommodate the SSH clients in your environment, you can configure the types of connections that will accept.
You can also configure the cryptographic algorithms (ciphers, MAC algorithms, key exchange algorithms, and signature types) that uses for SSH connections. For more in... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-ssh-connections-to-your-instance.md",
"title": "Configuring SSH connections to your instance"
} |
About the referrer policy for your enterprise
The referrer policy controls the information that transmits in HTTP headers when someone visits a link from to an external site.
By default, when a user on visits a link to another site from a file or comment on your instance, the request includes the hostname for your i... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-the-referrer-policy-for-your-enterprise.md",
"title": "Configuring the referrer policy for your enterprise"
} |
About cipher suite and algorithm configuration
allows you to configure which cipher suites and cryptographic algorithms to use for:
TLS connections on ports 443 (HTTPS web interface) and 8443 (HTTPS management console)
SSH connections on port 22 (Git operations via SSH) and port 122 (administrative shell access)
The... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls-and-ssh-ciphers.md",
"title": "Configuring TLS and SSH ciphers"
} |
About Transport Layer Security
TLS, which replaced SSL, is enabled and configured with a self-signed certificate when is started for the first time. As self-signed certificates are not trusted by web browsers and Git clients, these clients will report certificate warnings until you disable TLS or upload a certificate ... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls.md",
"title": "Configuring TLS"
} |
Security error prevented the resource from being loaded
To resolve these errors, you must update the Subject Alternative Names (SANs) your Let's Encrypt certificate by reissuing the certificate. Replacement of an instance's certificate requires user-facing downtime.
1. Communicate the upcoming downtime to your users, a... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls.md",
"title": "Configuring TLS"
} |
You must enable private mode if is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see AUTOTITLE.
With private mode enabled... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/enabling-private-mode.md",
"title": "Enabling private mode"
} |
About subdomain isolation
Subdomain isolation mitigates cross-site scripting and other related vulnerabilities. For more information, see Cross-site scripting on Wikipedia. We highly recommend that you enable subdomain isolation on .
When subdomain isolation is enabled, replaces several paths with subdomains. After en... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/enabling-subdomain-isolation.md",
"title": "Enabling subdomain isolation"
} |
If you use , you can block users on your network from authenticating to with accounts that are not members of your enterprise. This helps reduce the risk of your company's data being exposed to the public.
To enforce this restriction, you will configure your network proxy or firewall to inject a header into your users... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md",
"title": "Restricting access to GitHub.com using a corporate proxy"
} |
About network traffic restrictions
By default, authorized users can access your enterprise's resources from any IP address. You can restrict access to your enterprise's private resources by configuring a list that allows or denies access from specific IP addresses.
[!NOTE]
If your enterprise uses , enabling the IP a... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md",
"title": "Restricting network traffic to your enterprise with an IP allow list"
} |
Removing the passphrase from your key file
If you have a Linux machine with OpenSSL installed, you can remove your passphrase.
1. Rename your original key file.
shell
mv yourdomain.key yourdomain.key.orig
1. Generate a new key without a passphrase.
shell
openssl rsa -in yourdomain.key.orig -out yourdomain.k... | {
"source": "github-docs/admin/configuring-settings/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md",
"title": "Troubleshooting TLS errors"
} |
[!NOTE]
To configure or for your enterprise, see AUTOTITLE or AUTOTITLE. | {
"source": "github-docs/admin/configuring-settings/index.md",
"title": "Configuring GitHub Enterprise"
} |
By default, stores data for in the USA. To learn how handles data storage, see AUTOTITLE.
You can get started with data residency by setting up a trial of .
<a href="https://github.com/account/enterprises/new?refproduct=ghec&reftype=trial&refstyle=button&refplan=enterprise" target="blank" class="btn btn-primary mt-... | {
"source": "github-docs/admin/data-residency/about-github-enterprise-cloud-with-data-residency.md",
"title": "About GitHub Enterprise Cloud with data residency"
} |
Although your code and user data are stored within your chosen region, may store certain types of data outside your region, and may need to transfer some data outside your region.
If you are in doubt about any aspect of , contact your account manager.
Data stored in your region
stores the following data for your ent... | {
"source": "github-docs/admin/data-residency/about-storage-of-your-data-with-data-residency.md",
"title": "About storage of your data with data residency"
} |
Some features work differently or require additional configuration compared to the equivalent feature on .
Available features
is a developer platform that supports the entire software development lifecycle, including planning work, automating tests and deployments, and keeping code secure. To learn about available fe... | {
"source": "github-docs/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md",
"title": "Feature overview for GitHub Enterprise Cloud with data residency"
} |
When you adopt , you can choose where your company's code and data are stored.
In this guide, you will:
Start a trial to create an enterprise account with and a dedicated domain on
Add users by configuring authentication and provisioning with an identity management system
Learn about available features, including ... | {
"source": "github-docs/admin/data-residency/getting-started-with-data-residency-for-github-enterprise-cloud.md",
"title": "Getting started with data residency for GitHub Enterprise Cloud"
} |
If your enterprise uses , you can enable a policy to ensure that all inference processing and associated data for remain within your designated geographic region.
Supported regions
with data residency is currently available in the following regions:
United States
European Union
plans to add support for more regio... | {
"source": "github-docs/admin/data-residency/github-copilot-with-data-residency.md",
"title": "GitHub Copilot with data residency"
} |
To access your enterprise on , client systems must:
Trust 's SSH key fingerprints
Have access to 's hostnames and IP addresses
's SSH key fingerprints
To find these details, use the /meta API endpoint for your instance. For example, using the :
gh api /meta --hostname octocorp.ghe.com
For more information, see AUTOT... | {
"source": "github-docs/admin/data-residency/network-details-for-ghecom.md",
"title": "Network details for GHE.com"
} |
Viewing service status
If you're experiencing problems with a service that usually works, like pull requests or , you can check if an ongoing incident is affecting the service in your region. See 's status page at https://githubstatus.com.
Getting support
If you need help to resolve an issue, contact . Ensure you are ... | {
"source": "github-docs/admin/data-residency/resolving-issues-with-your-enterprise-on-ghecom.md",
"title": "Resolving issues with your enterprise on GHE.com"
} |
Next steps
To configure workflow execution protections for your enterprise, including setting up event and actor rules, see AUTOTITLE. | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/actions-policies/about-actions-policies.md",
"title": "About Actions policies"
} |
Configuring workflow execution protections
You configure workflow execution protections in the new Policies section of your settings. This Policies section is separate from your existing General settings.
1. Click Policies.
1. Create a ruleset, then add your event and actor rules.
1. Choose whether the ruleset is acti... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/actions-policies/workflow-execution-protections.md",
"title": "Workflow execution protections"
} |
About the unaffiliated users policy
By default, when a user loses access to all organizations in your enterprise, the user remains in your enterprise as an unaffiliated user. This can happen when you remove a user from organizations explicitly or remove an organization from your enterprise.
Unaffiliated users retain en... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding.md",
"title": "Controlling user offboarding with the unaffiliated users policy"
} |
Introduction
To learn more, see AUTOTITLE.
Importing rulesets
To import a prebuilt ruleset created by , see github/ruleset-recipes.
For more information, see AUTOTITLE.
How will I define where my ruleset applies?
Rulesets allow you to flexibly target the organizations, repositories, and branches where you want rules... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md",
"title": "Enforcing code governance in your enterprise with rulesets"
} |
About policies for using security features in your enterprise
You can enforce policies to manage the use of security features within organizations owned by your enterprise. You can allow or disallow people with admin access to a repository to enable or disable the security and analysis features.
Additionally, you can e... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise.md",
"title": "Enforcing policies for code security and analysis for your enterprise"
} |
What are policies for ?
Enterprise policies control the options that are available to enterprise members when they use .
If you don't enforce enterprise policies, organization owners and users with the "Manage organization Actions policies" permission have full control over for their organizations.
[!NOTE] must be e... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md",
"title": "Enforcing policies for GitHub Actions in your enterprise"
} |
About enterprise policies for
As an enterprise owner, you can set a policy to enable or disable across organizations in your enterprise. You can enable for all organizations, enable for specific organizations, or disable for all organizations.
If you disable for an organization, users cannot use or create codespace... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-codespaces-in-your-enterprise.md",
"title": "Enforcing policies for GitHub Codespaces in your enterprise"
} |
Enterprise admins can:
Enforce policies for organizations in the enterprise. See AUTOTITLE.
Enable or disable for organizations in the enterprise. See AUTOTITLE and AUTOTITLE. | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise.md",
"title": "Enforcing policies for GitHub Copilot in your enterprise"
} |
About enterprise policies for
allows your organizations to financially support developers who build the open source projects you depend on. For more information, see AUTOTITLE and AUTOTITLE.
By default, organizations that belong to an enterprise that pays by credit card cannot sponsor open source contributors. You ca... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-sponsors-in-your-enterprise.md",
"title": "Enforcing policies for GitHub Sponsors in your enterprise"
} |
Restricting access by
Enterprise owners can prevent their members from using to access resources owned by the enterprise. You can configure these restrictions for and independently with the following options:
Allow organizations to configure access requirements: Each organization owned by the enterprise can decide... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise.md",
"title": "Enforcing policies for personal access tokens in your enterprise"
} |
About policies for projects in your enterprise
You can enforce policies to control how enterprise members manage , or you can allow organization owners to manage policies for at the organization level.
Enforcing a policy for organization-wide projects
Across all organizations owned by your enterprise, you can enable ... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md",
"title": "Enforcing policies for projects in your enterprise"
} |
About policies for security settings in your enterprise
You can enforce policies to control the security settings for organizations owned by your enterprise. By default, organization owners can manage security settings.
Requiring two-factor authentication for organizations in your enterprise
If uses LDAP or built-in ... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md",
"title": "Enforcing policies for security settings in your enterprise"
} |
About policies for repository management in your enterprise
You can enforce policies to control how members of your enterprise manage repositories. You can also allow organization owners to manage policies for repository management.
[!NOTE] This page describes the policies you can set on the "Member privileges" page in... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md",
"title": "Enforcing repository management policies in your enterprise"
} |
After creating a ruleset at the enterprise level, you can make changes to the ruleset to alter how people can interact with the targeted repositories. For example, you can:
Add rules to better protect the branches or tags in those repositories
Switch your ruleset from "Evaluate" mode to "Active" after testing its eff... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md",
"title": "Managing code rulesets for repositories in your enterprise"
} |
About email restrictions for your enterprise
When you restrict email notifications, enterprise members can only use an email address in a verified or approved domain to receive email notifications about activity in organizations owned by your enterprise.
The domains can be inherited from the enterprise or configured fo... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise.md",
"title": "Restricting email notifications for your enterprise"
} |
About pre-receive hooks
When a push occurs, each script runs in an isolated environment and can perform checks on the content of the push. The scripts will cause the push to be accepted if the exit status is 0, or rejected if the exit status is non-zero.
Use pre-receive hooks to satisfy business rules, enforce regulato... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/about-pre-receive-hooks.md",
"title": "About pre-receive hooks"
} |
A pre-receive environment for is a Linux chroot environment. Because pre-receive hooks execute on every push event, they should be fast and lightweight. The environment needed for such checks will typically be minimal.
provides a default environment which includes these packages: awk, bash, coreutils, curl, find, gnu... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md",
"title": "Creating a pre-receive hook environment"
} |
Writing a pre-receive hook script
A pre-receive hook script executes in a pre-receive hook environment on . When you create a pre-receive hook script, consider the available input, output, exit status, and environment variables.
Input (stdin)
After a push occurs and before any refs are updated for the remote repositor... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md",
"title": "Creating a pre-receive hook script"
} |
Creating pre-receive hooks
1. Click Add pre-receive hook.
1. In the "Hook name" field, enter the name of the hook that you want to create.
1. Select the Environment dropdown menu, then click the environment on which you want the hook to run.
1. Under "Script," select the Select hook repository dropdown menu, then click... | {
"source": "github-docs/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-your-instance.md",
"title": "Managing pre-receive hooks on your instance"
} |
For more information, or to purchase , see .
If you have questions about the installation process, see AUTOTITLE. | {
"source": "github-docs/admin/installing-your-enterprise-server/index.md",
"title": "Installing {% data variables.product.prodname_enterprise %}"
} |
Prerequisites
You must have an AWS account capable of launching EC2 instances and creating EBS volumes. For more information, see the Amazon Web Services website.
Most actions needed to launch may also be performed using the AWS management console. However, we recommend installing the AWS command line interface (CLI... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md",
"title": "Installing GitHub Enterprise Server on AWS"
} |
You can deploy on global Azure or Azure Government.
Azure Local
[!NOTE] on Azure Local is now in public preview. During this public preview, you can only use GHES version 3.20.
If your organization requires sovereign deployments or operates in regulated environments, Azure Local is Microsoft's distributed infrastru... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md",
"title": "Installing GitHub Enterprise Server on Azure"
} |
Prerequisites
You must have a Google Cloud Platform account capable of launching Google Compute Engine (GCE) virtual machine (VM) instances. For more information, see the Google Cloud Platform website and the Google Cloud Platform documentation.
Most actions needed to launch your instance may also be performed using ... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md",
"title": "Installing GitHub Enterprise Server on Google Cloud Platform"
} |
Prerequisites
You must have Windows Server 2008 through Windows Server 2022, which supports Hyper-V.
Most actions needed to create your virtual machine (VM) may also be performed using the Hyper-V Manager. However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShe... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md",
"title": "Installing GitHub Enterprise Server on Hyper-V"
} |
Prerequisites
You must have access to an installation of OpenStack Horizon, the web-based user interface to OpenStack services. For more information, see the Horizon documentation.
Hardware considerations
Downloading the image
1. Under " On-premises", select the "Select your hypervisor" dropdown menu and click Open... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-openstack-kvm.md",
"title": "Installing GitHub Enterprise Server on OpenStack KVM"
} |
Prerequisites
You must have a VMware vSphere ESXi Hypervisor, applied to a bare metal machine that will run s. We support versions 5.5 to 8.0. The ESXi Hypervisor is free and does not include the (optional) vCenter Server. For more information, see the VMware ESXi documentation.
You will need access to a vSphere Clie... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md",
"title": "Installing GitHub Enterprise Server on VMware"
} |
About staging instances
recommends that you set up a separate environment to test backups, updates, or changes to the configuration for . This environment, which you should isolate from your production systems, is called a staging environment.
For example, to protect against loss of data, you can regularly validate th... | {
"source": "github-docs/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md",
"title": "Setting up a staging instance"
} |
About custom footers for your enterprise
You can configure the web UI for your enterprise to display a custom footer with up to five additional links. The custom footer appears above the default footer, to all users and on all pages of to all enterprise members and collaborators, on all repository and organization pa... | {
"source": "github-docs/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/configuring-custom-footers.md",
"title": "Configuring custom footers"
} |
About user messages
You can create global announcement banners, which appear at the top of every page.
There are several types of user messages.
Messages that appear on the sign in or sign out page
Mandatory messages, which appear once in a pop-up window that must be dismissed
Announcement banners, which appear at t... | {
"source": "github-docs/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md",
"title": "Customizing user messages for your enterprise"
} |
There are three ways to add organizations to your enterprise.
Create a new organization in your enterprise.
Invite an existing organization to join your enterprise.
Transfer an existing organization between enterprise accounts on .
See AUTOTITLE.
Limitations
If you use , you cannot transfer organizations between ... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md",
"title": "Adding organizations to your enterprise"
} |
You can also enforce your default setting on all current organization members in your instance using a command-line utility. For example, if you'd like to require every organization member's visibility to be public, you can set the default to public and enforce the default for all new members in the admin settings, and... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership.md",
"title": "Configuring visibility for organization membership"
} |
What are custom properties?
Custom properties are structured metadata fields that you can attach to repositories or organizations in . They allow you to decorate your repositories or organizations with information such as compliance frameworks, data sensitivity, or project details.
An enterprise can have up to 100 prop... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/custom-properties.md",
"title": "Custom properties"
} |
About custom properties
See AUTOTITLE.
This article relates to organization custom properties.
Allowed characters
Adding custom properties
You can add custom properties to your enterprise and set values for those properties for organizations in your enterprise.
You can also use the REST API to create and manage cust... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-custom-properties-for-organizations.md",
"title": "Managing custom properties for organizations"
} |
Connecting Jira to a organization
1. Click New .
[!NOTE]
If you haven't created an app before, this button will say, Register an application.
1. Fill in the application settings:
In the Application name field, type "Jira" or any name you would like to use to identify the Jira instance.
In the Homepag... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-projects-using-jira.md",
"title": "Managing projects using Jira"
} |
Organization owners might not have the necessary permissions to satisfy requests from members. For example, if an organization owner is not an enterprise owner, and is not enabled for that organization, they will not have the permissions to approve requests for .
In these cases, when an organization member requests ac... | {
"source": "github-docs/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-requests-for-copilot-business.md",
"title": "Managing requests for Copilot Business"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.