Installing GitHub Enterprise Server on XenServer

To install GitHub Enterprise Server on XenServer, you must deploy the GitHub Enterprise Server disk image to a XenServer host.

In this article

Note: Support for GitHub Enterprise Server on XenServer will be discontinued in GitHub Enterprise Server 3.3. For more information, see the GitHub Enterprise Server 3.1 release notes

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 install the XenServer Hypervisor on the machine that will run your GitHub Enterprise Server virtual machine (VM). We support versions 6.0 through 7.0.
  • We recommend using the XenCenter Windows Management Console for initial setup. Instructions using the XenCenter Windows Management Console are included below. For more information, see the Citrix guide "How to Download and Install a New Version of XenCenter."

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.

User licensesvCPUsMemoryAttached storageRoot storage
Trial, demo, or 10 light users432 GB150 GB200 GB
10 to 3,000848 GB300 GB200 GB
3,000 to 50001264 GB500 GB200 GB
5,000 to 80001696 GB750 GB200 GB
8,000 to 10,000+20160 GB1000 GB200 GB

If you plan to enable GitHub Actions for the users of your instance, review the requirements for hardware, external storage, and runners in "Getting started with GitHub Actions for GitHub Enterprise Server."

For more information about adjusting resources for an existing instance, see "Increasing storage capacity" and "Increasing CPU or memory resources."

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."

To configure GitHub Actions, you must provide external blob storage. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

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

The CPU and memory resources that GitHub Enterprise Server requires depend on the levels of activity for users, automations, and integrations.

If you plan to enable GitHub Actions for the users of your GitHub Enterprise Server instance, you may need to provision additional CPU and memory resources for your instance. For more information, see "Getting started with GitHub Actions for GitHub Enterprise Server."

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."

For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

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

Downloading the GitHub Enterprise Server image

  1. Navigate to the GitHub Enterprise Server download page.
  2. To download your license file, click Download license.
  3. Click Get the latest release of GitHub Enterprise Server.
  4. Select GitHub On-premises, then click XenServer (VHD).
  5. To download your license file, click Download license.

Creating the GitHub Enterprise Server instance

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. In XenCenter, import the GitHub Enterprise Server image you downloaded. For instructions, see the XenCenter guide "Import Disk Images."
    • For the "Enable Operating System Fixup" step, select Don't use Operating System Fixup.
    • Leave the VM powered off when you're finished.
  2. Create a new virtual disk to use as an attached storage volume for your instance data, and configure the size based on your user license count. For instructions, see the XenCenter guide "Add Virtual Disks."

Configuring the GitHub Enterprise Server instance

  1. Copy the virtual machine's public DNS name, and paste it into a web browser.
  2. At the prompt, upload your license file and set a management console password. For more information, see "Managing your GitHub Enterprise license."
  3. In the Management Console, configure and save your desired settings. For more information, see "Configuring the GitHub Enterprise Server appliance."
  4. The instance will restart automatically.
  5. Click Visit your instance.

Further reading

Did this doc help you?Privacy policy

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.