This guide will walk you through setting up, configuring and managing your GitHub Enterprise Server instance as an enterprise administrator.
GitHub provides two ways to deploy GitHub Enterprise.
- GitHub Enterprise Cloud
- GitHub Enterprise Server
GitHub hosts GitHub Enterprise Cloud. You can deploy and host GitHub Enterprise Server in your own datacenter or a supported cloud provider.
For more information about GitHub Enterprise Server, see "About GitHub Enterprise Server."
Part 1: Installing GitHub Enterprise Server
To get started with GitHub Enterprise Server, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing.
1. Creating your enterprise account
Before you install GitHub Enterprise Server, you can create an enterprise account on GitHub.com by contacting GitHub's Sales team. An enterprise account on GitHub.com is useful for billing and for shared features with GitHub.com via GitHub Connect. For more information, see "About enterprise accounts."
2. Installing GitHub Enterprise Server
To get started with GitHub Enterprise Server, you will need to install the appliance on a virtualization platform of your choice. For more information, see "Setting up a GitHub Enterprise Server instance."
3. Using the Management Console
You will use the Management Console to walk through the initial setup process when first launching your GitHub Enterprise Server instance. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "Administering your instance from the web UI."
4. Configuring your GitHub Enterprise Server instance
In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage your GitHub Enterprise Server instance. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "Configuring GitHub Enterprise."
You can use the default network settings used by GitHub Enterprise Server via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "Configuring network settings."
5. Configuring high availability
You can configure your GitHub Enterprise Server instance for high availability to minimize the impact of hardware failures and network outages. For more information, see "Configuring high availability."
6. Setting up a staging instance
You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to your GitHub Enterprise Server instance. For more information, see "Setting up a staging instance."
7. Designating backups and disaster recovery
To protect your production data, you can configure automated backups of your GitHub Enterprise Server instance with GitHub Enterprise Server Backup Utilities. For more information, see "Configuring backups on your instance."
8. Managing billing for your enterprise
Billing for all the organizations and GitHub Enterprise Server instances connected to your enterprise account is aggregated into a single bill charge for all of your paid GitHub.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "About billing for your enterprise."
Part 2: Organizing and managing your team
As an enterprise owner or administrator, you can manage settings on user, repository, team and organization levels. You can manage members of your enterprise, create and manage organizations, set policies for repository management, and create and manage teams.
1. Managing members of your GitHub Enterprise Server instance
You can manage settings and audit activity for the members of your GitHub Enterprise Server instance. You can promote an enterprise member to be a site administrator, manage dormant users, view the audit log for user activity, and customize messages that enterprise members will see. For more information, see "Managing users in your enterprise."
2. Creating organizations
You can create new organizations in your GitHub Enterprise Server instance to reflect your company or group's structure. For more information, see "Creating a new organization from scratch."
3. Adding members to organizations
You can add members to organizations in your GitHub Enterprise Server instance as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "Adding people to your organization" and "Configuring visibility for organization membership."
4. Creating teams
Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "Creating a team" and "