Deploy GitHub Enterprise into a new VPC on AWS

To deploy GitHub Enterprise on AWS, view the Quick Start deployment guide. For additional automated reference deployments from AWS, view the complete Quick Start catalog.

github-mark-95px


This Quick Start deploys a free, 45-day trial version of GitHub Enterprise automatically into your AWS account in about 15 minutes.

GitHub Enterprise is a development and collaboration platform built on Git that enables developers to build and share software easily and effectively. It provides an integrated platform for continuous integration and development, a non-linear workflow for collaboration, and in-depth monitoring and auditing for administrators. By deploying GitHub Enterprise on AWS, you can take advantage of a configurable infrastructure for your coding and deployment tasks. 

The Quick Start includes AWS CloudFormation templates that automate the deployment, and a guide with step-by-step instructions for deploying, configuring, and testing GitHub Enterprise on AWS.

  • What you'll build

    Use this Quick Start to set up the following GitHub Enterprise environment on AWS:

    • A virtual private cloud (VPC) with a single Availability Zone and public subnet.*
    • An Internet gateway to provide access to the Internet.*
    • In the public subnet, a GitHub Enterprise EC2 instance with an attached, customizable Amazon Elastic Block Store (Amazon EBS) volume.
    • An Amazon CloudWatch monitoring resource that will automatically restore the GitHub Enterprise EC2 instance if it becomes unresponsive.
    • An AWS Identity and Access Management (IAM) role with the necessary permissions to manage access to resources.
    • A security group to enable communication within the VPC and to interact with the GitHub Enterprise EC2 instance.
    • A sample Github organization and repository you can use to test the deployment.


    * You can choose to create a new VPC or deploy GitHub Enterprise into your existing VPC on AWS. The template that deploys the Quick Start into an existing VPC skips the creation of components marked by asterisks and prompts you for your existing configuration.

    For details, see the Quick Start deployment guide.

  • Deployment details

    Build your GitHub Enterprise environment in a few simple steps:

    1. Sign up for an AWS account at https://aws.amazon.com.
    2. Sign up for a free, 45-day trial license for GitHub Enterprise at https://enterprise.github.com/sn-trial.
    3. Launch the Quick Start into a new VPC, if you want to build a new AWS infrastructure.
      -or-
      Launch the Quick Start into an existing VPC, if you already have your AWS environment set up.
      Each deployment takes about 15 minutes.
    4. Test the deployment by accessing the GitHub Enterprise instance on AWS, and by accessing and cloning the sample repository set up by the Quick Start.


    You can customize your deployment by configuring your network resources and modifying the instance type and storage options for the GitHub Enterprise web server.

    For detailed deployment and configuration instructions, see the Quick Start deployment guide.

  • Cost and licenses

    You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional cost for using the Quick Start.

    The AWS CloudFormation template for this Quick Start includes configuration parameters that you can customize. Some of these settings, such as instance type and storage, will affect the cost of deployment. See the pricing pages for each AWS service you will be using for cost estimates.

    This Quick Start requires a trial version of GitHub Enterprise, which is available for free from GitHub.