getting-started-with-github-enterprise-server.md

title	intro	versions
Getting started with GitHub Enterprise Server	Get started with setting up and managing {% data variables.location.product_location %}.	ghes *

This guide will walk you through setting up, configuring and managing {% data variables.location.product_location %} as an enterprise administrator.

{% data variables.product.github %} provides two ways to deploy {% data variables.product.prodname_enterprise %}.

• {% data variables.product.prodname_ghe_cloud %}
• {% data variables.product.prodname_ghe_server %}

{% data variables.product.company_short %} hosts {% data variables.product.prodname_ghe_cloud %}. You can deploy and host {% data variables.product.prodname_ghe_server %} in your own datacenter or a supported cloud provider.

For more information about {% data variables.product.prodname_ghe_server %}, see AUTOTITLE.

Part 1: Installing {% data variables.product.prodname_ghe_server %}

To get started, you will need to create your enterprise account, install the instance, use the {% data variables.enterprise.management_console %} for initial setup, configure your instance, and manage billing.

1. Creating your enterprise account

Before you install {% data variables.product.prodname_ghe_server %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting {% data variables.product.github %}'s Sales team. An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see AUTOTITLE.

2. Installing {% data variables.product.prodname_ghe_server %}

To get started, you will need to install the appliance on a virtualization platform of your choice. For more information, see AUTOTITLE.

3. Using the {% data variables.enterprise.management_console %}

You will use the {% data variables.enterprise.management_console %} to walk through the initial setup process when first launching {% data variables.location.product_location %}. You can also use the {% data variables.enterprise.management_console %} to manage instance settings such as the license, domain, authentication, and TLS. For more information, see AUTOTITLE.

4. Configuring {% data variables.location.product_location %}

In addition to the {% data variables.enterprise.management_console %}, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.location.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see AUTOTITLE.

You can use the default network settings used by {% data variables.product.prodname_ghe_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 AUTOTITLE.

5. Configuring high availability

You can configure {% data variables.location.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see AUTOTITLE.

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 {% data variables.location.product_location %}. For more information, see AUTOTITLE.

7. Designating backups and disaster recovery

To protect your production data, you can configure automated backups of {% data variables.location.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see AUTOTITLE.

8. Managing billing for your enterprise

Billing for all the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom_the_website %} services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see AUTOTITLE.

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 {% data variables.location.product_location %}

{% data reusables.getting-started.managing-enterprise-members %}

2. Creating organizations

{% data reusables.getting-started.creating-organizations %}

3. Adding members to organizations

{% data reusables.getting-started.adding-members-to-organizations %}

4. Creating teams

{% data reusables.getting-started.creating-teams %}

5. Setting organization and repository permission levels

{% data reusables.getting-started.setting-org-and-repo-permissions %}

6. Enforcing repository management policies

{% data reusables.getting-started.enforcing-repo-management-policies %}

{% ifversion enterprise-readme %}

7. Creating a README for the enterprise

{% data reusables.enterprise.about-readmes %} For more information, see AUTOTITLE.

{% endif %}

Part 3: Building securely

To increase the security of {% data variables.location.product_location %}, you can configure authentication for enterprise members, use tools and audit logging to stay in compliance, configure security and analysis features for your organizations, and optionally enable {% data variables.product.prodname_GHAS %} features.

1. Authenticating enterprise members

You can use {% data variables.product.prodname_ghe_server %}'s built-in authentication method, or you can choose between an external authentication provider, such as CAS, LDAP, or SAML, to integrate your existing accounts and centrally manage user access to {% data variables.location.product_location %}. For more information, see AUTOTITLE.

You can also require two-factor authentication for each of your organizations. For more information, see AUTOTITLE.

2. Staying in compliance

You can implement required status checks and commit verifications to enforce your organization's compliance standards and automate compliance workflows. You can also use the audit log for your organization to review actions performed by your team. For more information, see AUTOTITLE and AUTOTITLE.

3. Configuring security features for your organizations

{% data reusables.getting-started.configuring-security-features %}

4. Enabling {% data variables.product.prodname_GHAS %} features

You can upgrade your {% data variables.product.prodname_ghe_server %} license to include {% ifversion ghas-products %}{% data variables.product.prodname_GH_code_security %} or {% data variables.product.prodname_GH_secret_protection %}{% else %}{% data variables.product.prodname_GHAS %}{% endif %}. Upgrading will provide extra features that help users find and fix security problems in their code, such as code and secret scanning. For more information, see AUTOTITLE.

Part 4: Customizing and automating your enterprise's work on {% data variables.product.github %}

You can customize and automate work in organizations in your enterprise with {% data variables.product.github %} and {% data variables.product.prodname_oauth_apps %}, {% data variables.product.prodname_ghe_server %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}.

1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}

You can build integrations with the {% data variables.product.prodname_ghe_server %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see AUTOTITLE.

2. Using the {% data variables.product.prodname_ghe_server %} API

{% data reusables.getting-started.api %}

3. Building {% data variables.product.prodname_actions %}

{% data reusables.getting-started.actions %}

For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, see AUTOTITLE.

4. Publishing and managing {% data variables.product.prodname_registry %}

{% data reusables.getting-started.packages %}

For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.location.product_location %}, see AUTOTITLE.

5. Using {% data variables.product.prodname_pages %}

{% data reusables.getting-started.github-pages-enterprise %}

Part 5: Connecting with other {% data variables.product.github %} resources

You can use {% data variables.product.prodname_github_connect %} to share resources.

If you are the owner of both a {% data variables.product.prodname_ghe_server %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.location.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see AUTOTITLE.

Part 6: Using {% data variables.product.github %}'s learning and support resources

Your enterprise members can learn more about Git and {% data variables.product.github %} with our learning resources, and you can get the support you need when setting up and managing {% data variables.location.product_location %} with {% data variables.product.github %} Enterprise Support.

1. Reading about {% data variables.product.prodname_ghe_server %} on {% data variables.product.prodname_docs %}

You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_server %}. For more information, see AUTOTITLE.

{% data reusables.enterprise.best-practices %}

2. Learning with {% data variables.product.prodname_learning %}

{% data reusables.getting-started.learning-enterprise %}

3. Working with {% data variables.product.github %} Enterprise Support

{% data reusables.getting-started.contact-support-enterprise %}