1 Installing
Hayden Walker / Winfinity edited this page 2022-05-04 20:30:03 +00:00

Time to get into the good stuff. I'll be using OpenStack - you can achieve the same results with VirtualBox or VMware.

Download your License

You'll need this to install Enterprise Server. Go to enterprise.github.com/login to download it. If you didn't receive a welcome email, request a password reset using the email you used to submit the information.
Once logged in you'll reach your dashboard. Click the "Download License" link. It should be saved as a .ghl file. Proceed to the next step.

Installation

Now we're cooking with gas. As of writing the latest Enterprise Server version is 3.4.2 - click here to be taken to the download page. Select the hypervisor.

Hypervisor Selection

  • If you're on VirtualBox or VMWare, choose .ova
  • If you use Hyper-V or VirtualBox, choose .vhd
  • If you use OpenStack/QEMU/KVM/Whatever, choose .qcow2 Once you've selected a hypervisor, proceed to the next step.

Downloading the Image

Click the Download button. Grab a cup of coffee or something. This is gonna take a while.

Uploading The Image

Note: this step applies only to OpenStack users. If you're using VirtualBox or VMware Workstation, skip this step.

Via Horizon

Log into Horizon. At your dashboard, click Images. On this page you need to click "New Image". Fill out the properties. Leave Image Requirements empty.
As of right now GitHub requires at least 250GB of storage. I recommend allocating 300GB. Allocating lower than 200GB will cause deployment to fail. Once your image uploads, DO NOT DEPLOY AN INSTANCE - you still have configuration to do.

Via OpenStack CLI

(to be written soon, use Horizon for now)

Launch!!

OpenStack users: follow the first few steps in this section.

  • Step 1 - Navigate to Flavors by going to the Admin tab, Compute, and then Flavors.
  • Step 2 - Create a flavor with the following configuration (Name does not matter):
    OpenStack flavor configuration
    MAKE SURE YOU SET SWAP TO 0MB, IF YOU DON'T THIS WILL CAUSE PROBLEMS!!!
    All other users start here (VirtualBox, VMware, Hyper-V)
  • Step 3 - Create a volume for storage. In OpenStack, do this by going to Project -> Volumes -> Volumes. Create a new volume before creating the instance. You'll need 2 volumes: 1 with the GitHub Enterprise system on it (which will be your instance's root disk) and 1 for additional storage (which will be mounted at /data/user). VirtualBox, VMware, and Hyper-V users may skip this step.
  • OpenStack users, create yet another volume for the system. Select "From Image" as Volume Source and use the Enterprise Server image you have uploaded to your server. Set the size to 300GB.
  • Step 4 - deploy your instance. VMware users, go to File -> Open and select the .ova file you downloaded earlier. Wait for it to import and hit run!
  • VirtualBox users - go to "Tools -> Import" and select the .ova file you downloaded.
  • OpenStack users - go to "Compute -> Instances" and hit "Create Instance". Name your instance, then in Source click "Volume" and click the up arrow on the volume you created with the Enterprise image. Use the new flavor you created to deploy your instance. Fill everything else out and finally hit Launch. Attach the storage volume you created. Voila - you've deployed GHE. Proceed to "Configuration".