Get started with GitHub Enterprise Local (preview)

This article explains how to onboard to the public preview and deploy GitHub Enterprise Local on Azure Local.

Important

This feature is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

Prerequisites

GitHub Enterprise Local is in public preview. To express interest, contact your Microsoft account team or submit the GitHub Enterprise Local Preview Sign-Up.

Microsoft reviews survey submissions on a rolling basis, with evaluations conducted every two weeks. Approved organizations are contacted with onboarding details.

Important

Microsoft provides the deployment PowerShell script only to approved public preview participants after they submit the onboarding survey and are selected for preview onboarding.

Azure Local might support running GitHub Enterprise Local on both Integrated and Premier hardware solutions, provided sufficient capacity is available to run the GitHub Enterprise Server (GHES) VM. Current offerings are available at Azure Local Solutions | Catalog. Plan compute, memory, storage, and network resources accordingly.

GHES provides VM sizing guidance based on your use cases and requirements, such as:

  • Number of developers

  • Repository size and growth

  • CI/CD pipeline frequency

  • Artifact storage requirements

For more information, see the Minimum recommended requirements.

Deploy GitHub Enterprise Local

GitHub Enterprise Local supports both single-node and multi-node Azure Local deployment options. Single-node Azure Local runs GHES as a standalone VM for preview and proof-of-concept scenarios. For production-oriented deployments, the same single GHES VM runs on a multi-node Azure Local cluster. Azure Local provides VM-level high availability and failover, while GHES itself remains a single, non-clustered instance.

A typical deployment includes the following steps:

  1. Prepare Azure Local infrastructure. Ensure you set up an Azure Local environment with sufficient capacity to run the GHES VM image.

  2. Download the GitHub Enterprise Local VM image. Place the image in a location that an Azure Local node can see and access.

    To reduce deployment time, download the image directly to the target location specified during deployment, because the deployment process copies the image into Azure Local storage.

  3. Deploy the GitHub Enterprise Local VM image. Use the PowerShell script provided during public preview onboarding.

  4. Complete GHES setup by using the admin console. Use the admin console to complete the initial configuration.

  5. Integrate identity providers and configure organizations. Set up identity providers and configure your organizations.

  6. Enable Actions, Packages, and Advanced Security. Configure these features as needed.

Next steps

  • Last updated on