reference deployment

GitHub Enterprise on AWS

Development, continuous integration, and collaboration platform on the AWS Cloud

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.

aws logo

This Quick Start was developed by AWS solutions architects.

  •  What you'll build
  •  How to deploy
  •  Cost and licenses
  •  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.

    * The template that deploys the Quick Start into an existing VPC skips the tasks marked by asterisks and prompts you for your existing VPC configuration.

  •  How to deploy
  • To build your GitHub Enterprise environment, follow the instructions in the deployment guide. The deployment process includes these steps:

    1. If you don't already have an AWS account, sign up 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. Each deployment takes about 15 minutes. You can choose from two options:
    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.

  •  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.