Installing GitHub Enterprise Server on Azure

To install GitHub Enterprise Server on Azure, you must deploy onto a DS-series instance and use Premium-LRS storage.

In this article

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

You can deploy GitHub Enterprise Server on global Azure or Azure Government.

Prerequisites

  • You must have a GitHub Enterprise license file. To download an existing license file or request a trial license, visit enterprise.github.com. For more information, see "Managing your GitHub Enterprise license."
  • You must have an Azure account capable of provisioning new machines. For more information, see the Microsoft Azure website.
  • Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "Install Azure CLI 2.0."

Hardware considerations

Minimum requirements

We recommend different hardware configurations depending on the number of user licenses for your GitHub Enterprise Server instance. If you provision more resources than the minimum requirements, your instance will perform and scale better.

Minimum requirements for an instance with beta features enabled are bold in the following table. For more information, see "Beta features in GitHub Enterprise Server 2.22."

User licensesvCPUsMemoryAttached storageRoot storage
Trial, demo, or 10 light users2
or 4
16 GB
or 32 GB
100 GB
or 150 GB
200 GB
10 to 3,0004
or 8
32 GB
or 48 GB
250 GB
or 300 GB
200 GB
3,000 to 50008
or 12
64 GB500 GB200 GB
5,000 to 800012
or 16
96 GB750 GB200 GB
8,000 to 10,000+16
or 20
128 GB
or 160 GB
1000 GB200 GB

Beta features in GitHub Enterprise Server 2.22

If you enable beta features in GitHub Enterprise Server 2.22, your instance requires additional hardware resources. For more information about the beta features, see the release notes for the 2.22 series on the GitHub Enterprise website. For more information about adjusting resources for an existing instance, see "Increasing storage capacity" and "Increasing CPU or memory resources."

If you enable the beta for GitHub Actions on your instance, we recommend planning for additional capacity.

The additional CPU and memory resources you need to provision for your instance depend on the number of workflows your users run concurrently, and the overall levels of activity for users, automations, and integrations.

Maximum jobs per minutevCPUsMemory
Light testing430.5 GB
25861 GB
3516122 GB
10032244 GB

Storage

We recommend a high-performance SSD with high input/output operations per second (IOPS) and low latency for GitHub Enterprise Server. Workloads are I/O intensive. If you use a bare metal hypervisor, we recommend directly attaching the disk or using a disk from a storage area network (SAN).

Your instance requires a persistent data disk separate from the root disk. For more information, see "System overview."

If you enable the beta of GitHub Actions in GitHub Enterprise Server 2.22, you'll need to configure external blob storage. For more information, see "Enabling GitHub Actions and configuring storage."

You can resize your instance's root disk by building a new instance or using an existing instance. For more information, see "Increasing storage capacity."

CPU and memory

GitHub Enterprise Server requires more CPU and memory resources depending on levels of activity for users, automations, and integrations.

When you increase CPU resources, we recommend adding at least 6.5 GB of memory for each vCPU (up to 16 vCPUs) that you provision for the instance. When you use more than 16 vCPUs, you don't need to add 6.5 GB of memory for each vCPU, but you should monitor your instance to ensure it has enough memory.

Warning: We recommend that users configure webhook events to notify external systems of activity on GitHub Enterprise Server. Automated checks for changes, or polling, will negatively impact the performance and scalability of your instance. For more information, see "About webhooks."

You can increase your instance's CPU or memory resources. For more information, see "Increasing CPU or memory resources.

Determining the virtual machine type

Before launching your GitHub Enterprise Server instance on Azure, you'll need to determine the type of virtual machine that best fits the needs of your organization.

Supported VM types and regions

The GitHub Enterprise Server appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. For more information, see "Supported VMs" in the Azure documentation. For general information about available VMs, see the Azure virtual machines overview page.

GitHub Enterprise Server supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "Products available by region."

We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can use any supported VM type. Based on your user license count, we recommend the following instance types.

SeatsRecommended type
Trial, demo, or 10 light usersStandard_DS11_v2
10 - 3000Standard_DS12_v2
3000 - 8000Standard_DS14_v2
8000 - 10000+Standard_DS15_v2

Note: You can always scale up your CPU or memory by resizing your instance. However, because resizing your CPU or memory requires downtime for your users, we recommend over-provisioning resources to account for scale.

Creating the GitHub Enterprise Server virtual machine

To create the instance, you'll need to import the GitHub Enterprise Server image to your virtual machine and attach an additional storage volume for your instance data. For more information, see "Hardware considerations."

  1. Find the most recent GitHub Enterprise Server appliance image. For more information about the vm image list command, see "az vm image list" in the Microsoft documentation.

    $ az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V
  2. Create a new VM using the appliance image you found. For more information, see "az vm create" in the Microsoft documentation.

    Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "Resource groups" in the Microsoft documentation.

    $ az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS
  3. Configure the security settings on your VM to open up required ports. For more information, see "az vm open-port" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.

    $ az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER

    This table identifies what each port is used for.

    PortServiceDescription
    22SSHGit over SSH access. Clone, fetch, and push operations to public/private repositories supported.
    25SMTPSMTP with encryption (STARTTLS) support.
    80HTTPWeb application access. All requests are redirected to the HTTPS port when SSL is enabled.
    122SSHInstance shell access. The default SSH port (22) is dedicated to application git+ssh network traffic.
    161/UDPSNMPRequired for network monitoring protocol operation.
    443HTTPSWeb application and Git over HTTPS access.
    1194/UDPVPNSecure replication network tunnel in high availability configuration.
    8080HTTPPlain-text web based Management Console. Not required unless SSL is disabled manually.
    8443HTTPSSecure web based Management Console. Required for basic installation and configuration.
    9418GitSimple Git protocol port. Clone and fetch operations to public repositories only. Unencrypted network communication. If you have enabled private mode on your instance, then opening this port is only required if you also enabled anonymous Git read access. For more information, see "Enforcing repository management policies in your enterprise."
  4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "az vm disk attach" in the Microsoft documentation.

    Pass in options for the name of your VM (for example, ghe-acme-corp), the resource group, the premium storage SKU, the size of the disk (for example, 100), and a name for the resulting VHD.

    $ az vm disk attach --vm-name VM_NAME -g RESOURCE_GROUP --sku Premium_LRS --new -z SIZE_IN_GB --name ghe-data.vhd --caching ReadWrite

    Note: For non-production instances to have sufficient I/O throughput, the recommended minimum disk size is 40 GiB with read/write cache enabled (--caching ReadWrite).

Configuring the GitHub Enterprise Server virtual machine

  1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the vm list command. For more information, see "az vm list" in the Microsoft documentation.

    $ az vm list -d -g RESOURCE_GROUP -o table
    > Name    ResourceGroup    PowerState    PublicIps     Fqdns    Location    Zones
    > ------  ---------------  ------------  ------------  -------  ----------  -------
    > VM_NAME RESOURCE_GROUP   VM running    40.76.79.202           eastus
    

    Note: Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "Create a fully qualified domain name in the Azure portal for a Linux VM."

  2. Copy the virtual machine's public DNS name, and paste it into a web browser.

  3. At the prompt, upload your license file and set a management console password. For more information, see "Managing your GitHub Enterprise license."

  4. In the Management Console, configure and save your desired settings. For more information, see "Configuring the GitHub Enterprise Server appliance."

  5. The instance will restart automatically.

  6. Click Visit your instance.

    Further reading

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.