Installing and configuring GitHub Enterprise Server

This guide helps system administrators and operations and security specialists set up, customize, and monitor GitHub Enterprise Server.

For more information, or to purchase GitHub Enterprise, see GitHub Enterprise.

If you have questions about the installation process, see "Working with GitHub Enterprise Support."

Table of contents

• System overview

• Setting up a GitHub Enterprise Server instance

  • Installing GitHub Enterprise Server on AWS
  • Installing GitHub Enterprise Server on Azure
  • Installing GitHub Enterprise Server on Google Cloud Platform
  • Installing GitHub Enterprise Server on Hyper-V
  • Installing GitHub Enterprise Server on OpenStack KVM
  • Installing GitHub Enterprise Server on VMware
  • Installing GitHub Enterprise Server on XenServer
  • Setting up a staging instance

• Configuring the GitHub Enterprise Server appliance

  • Accessing the Management Console
  • Accessing the administrative shell (SSH)
  • Enabling and scheduling maintenance mode
  • Configuring backups on your appliance
  • Site admin dashboard
  • Enabling private mode
  • Configuring the default visibility of new repositories on your appliance
  • Disabling the merge conflict editor for pull requests between repositories
  • Disabling Git SSH access on GitHub Enterprise Server
  • Configuring GitHub Pages on your appliance
  • Configuring rate limits
  • Setting Git push limits
  • Troubleshooting SSL errors
  • Configuring time synchronization
  • Command-line utilities
  • About the GitHub Enterprise Server API

• Configuring your GitHub Enterprise Server network settings

  • Configuring the IP address using the virtual machine console
  • Configuring DNS nameservers
  • Configuring a hostname
  • Validating your domain settings
  • Configuring TLS
  • Enabling subdomain isolation
  • Configuring an outbound web proxy server
  • Configuring built-in firewall rules
  • Network ports
  • Using GitHub Enterprise Server with a load balancer

• Monitoring your GitHub Enterprise Server appliance

  • Accessing the monitor dashboard
  • Recommended alert thresholds
  • Setting up external monitoring
  • Configuring collectd
  • Log forwarding
  • Monitoring using SNMP

• Monitoring activity on your GitHub Enterprise Server instance

  • Activity dashboard
  • Audit logging
  • Searching the audit log
  • Audited actions
  • Viewing push logs

• Updating the virtual machine and physical resources

  • Migrating Elasticsearch indices to GitHub Enterprise Server 2.14 or later
  • Upgrade requirements
  • Upgrading GitHub Enterprise Server
  • Enabling automatic update checks
  • Increasing storage capacity
  • Increasing CPU or memory resources
  • Migrating from GitHub Enterprise 11.10.x to 2.1.23

• Configuring GitHub Enterprise Server for high availability

  • About high availability configuration
  • Creating a high availability replica
  • Initiating a failover to your replica appliance
  • Recovering a high availability configuration
  • Removing a high availability replica
  • About geo-replication

• Configuring Git Large File Storage on GitHub Enterprise Server

  • Configuring Git Large File Storage
  • Configuring Git Large File Storage to use a third party server
  • Migrating to a different Git Large File Storage server

• Managing your GitHub Enterprise Server license

  • About license files
  • Downloading your license
  • Updating your license