This guide is targeted at system administrators and operations / security specialists. It documents the process of deploying GitHub Enterprise in your organization and includes important information on operational concerns like setting up backups and a DR plan, integrating with external authentication, network, and monitoring services, and scaling as usage grows over time.
GitHub Enterprise is distributed as a virtual machine image that you install and manage within your existing infrastructure. If you have not already purchased GitHub Enterprise, see enterprise.github.com for more information on features and frequently asked questions. To sign up for a trial, visit the trial sign-up page. If you have any further questions, feel free to contact our Sales team at sales@github.com.
If you already have an account and are migrating to GitHub Enterprise, you can obtain the virtual machine image and required license file from the GitHub Enterprise download page after signing in to your account:
https://enterprise.github.com/download
Once you've obtained your license and virtual machine image, you're ready to go! Follow this guide to set up your GitHub Enterprise installation.
Table of Contents
- System overview
-
Setting up a GitHub Enterprise instance
- Installing GitHub Enterprise on AWS
- Installing GitHub Enterprise on Azure
- Installing GitHub Enterprise on Google Cloud Platform
- Installing GitHub Enterprise on Hyper-V
- Installing GitHub Enterprise on OpenStack KVM
- Installing GitHub Enterprise on VMware
- Installing GitHub Enterprise on XenServer
- Setting up a staging instance
-
Configuring the GitHub Enterprise appliance
- Accessing the Management Console
- Accessing the administrative shell (SSH)
- Enabling and scheduling maintenance mode
- Enabling private mode
- Configuring the default visibility of new repositories on your appliance
- Configuring GitHub Pages on your appliance
- Troubleshooting SSL errors
- Configuring time synchronization
-
Network configuration
- About DNS nameservers
- Configuring nameservers
- About subdomain isolation
- Enabling subdomain isolation
- About TLS
- Configuring TLS
- Configuring hostnames
- Validating your domain settings
- Configuring a proxy server
- Configuring built-in firewall rules
- Network ports to open
- Using GitHub Enterprise with a load balancer
- System resource monitoring and alerting
-
Updating the virtual machine and physical resources
- Migrating audit logs to GitHub Enterprise 2.11 or later
- About upgrade requirements
- Upgrading GitHub Enterprise
- Finding the current GitHub Enterprise release
- Enabling automatic update checks
- Increasing storage capacity
- Increasing CPU or memory resources
- Migrating from GitHub Enterprise 11.10.x to 2.1.23
- Backups and disaster recovery
- Configuring GitHub Enterprise for High Availability
-
Configuring Git Large File Storage on GitHub Enterprise
- Configuring Git Large File Storage for a repository
- Configuring Git Large File Storage for every repository owned by a user account or organization
- Configuring Git Large File Storage for your appliance
- Configuring Git Large File Storage to use a third party server
- Migrating to a different Large File Storage server