Setup Guide

1. Create subscription

HyperEnv for GitHub Actions Runner is available on the AWS Marketplace. The following steps describe how to subscribe to HyperEnv for GitHub Actions Runner.

1. Go to AWS Marketplace and click Continue to Subscribe.
2. Read through the terms and click Accept Terms.
3. It will take a while to enable the susbcription.
4. Wait until the subscription is active and click Continue to Configuration.
5. Keep the defaults for fullfillment option and software version. Choose the region you want to launch HyperEnv for GitHub Actions Runner in and click Continue to Launch.
6. Keep the defaults and click Launch.
7. You are redirected to CloudFormation.

2. Launch with CloudFormation

We provide a CloudFormation template that spins up and configures all the releveant AWS resources - EC2 instances, security groups, an API gateway, Lambda functions, and many more - for you in an automated way.

1. Step Create stack
   1. The AWS Marketplace populates all the configuration parameters for step 1. Proceed by clicking Nex.
   
2. Step Specify stack details
   1. Set a name for the CloudFormation stack. We recommend hyperenv-github-actions.
   2. Continue with the required configuration parameters.
      1. VpcId (Bring Your Own VPC only) - The VPC used when launching EC2 instances to execute GitHub runners.
      2. SubnetIds (Bring Your Own VPC only) - The subnets used when launching EC2 instances to execute GitHub runners. Define at least two subnets with route to Internet or NAT Gateway.
      3. KeyPair - The key pair allowing you to establish a SSH connection with the EC2 instance executing the GitHub runner.
      
   3. Review the rest of the parameters and go with the defaults (recommended).
3. Step Configure stack options

   There is nothing to configure here. Keep the defaults and click Next

   
4. Step Review

   Scroll to the bottom of the page, enable I acknowledge that AWS CloudFormation might create IAM resources, and click Create stack.

   
5. The stack status is CREATE_IN_PROGRESS. Reload the list of stacks from time to time and wait until the CloudFormation stack hyperenv-github-actions switches to CREATE_COMPLETE.
6. Switch to the Outputs tab and search for the output named NextStepUrl and click the shown link.

By following the NextStepUrl you will be guided through the process of installing the GitHub app next.