NAV

Try CircleCI Enterprise

CircleCI Enterprise is a scalable CI/CD platform that supports clusters of tens or hundreds of build machines. This document provides instructions for installing and running the platform on a single virtual machine to provide a simple mechanism for getting started with a small trial in any environment:

Prerequisites

The following requirements must be met for successful trial installation:

  • Sign-up to recieve a trial license file.
  • Use GitHub.com or GitHub Enterprise for version control.
  • Machines running CircleCI Enterprise and GitHub must be able to reach each other on the network.
  • CircleCI Enterprise machine must have outbound internet access. If you use a proxy server, Contact us for instructions.

Steps for Installation on AWS EC2

Use this procedure to install CircleCI Enterprise on a single EC2 VM by using the pre-made Amazon Machine Image (AMI) which is a special type of virtual appliance that is used to create a virtual machine within the Amazon Elastic Compute Cloud (“EC2”).

Note: All builds that run on the installed machine will have access to the AWS Identity and Access Management (IAM) privileges associated with its instance profile. Do not give any inappropriate privileges to your instance. It is possible to block this access with iptables rules in a production setup, contact support for specific instructions.

  1. Find the Amazon Machine Image with at least 8G of RAM in your region from the following list:
    Go!
  2. During the Configure Security Group step, open ports 22, 80, 443, and 8800.
  3. (Optional) To enable developers to SSH into builds for debugging purposes, open ports 64535-65535.
  4. After the VM is lauched, go to the public or private IP address or hostname for the VM to complete the rest of the guided installation process.
  5. Complete the process by choosing an SSL certificate option, uploading the license, setting the admin password and hostnames, enabling GitHub OAuth registration, and defining protocol settings. The application start up process begins by downloading the ~160 MB docker image, so it may take some time to complete.
  6. Open the CircleCI Enterprise app and click Get Started to authorize your GitHub account. The Add Projects page appears where you can select a project for your first build.

AWS Installation Video Tutorial

Following is a short video walkthrough of the entire install process on AWS:

Installation in a Data Center or Cloud Provider Other Than AWS

  1. Launch a VM with at least 8GB of RAM, 100GB of disk space on the root volume, and a version of Linux that supports Docker, for example Ubuntu Trusty 14.04.

  2. Open ports 22 and 8800 to administrators, open ports 80 and 443 to all users, and optionally open ports 64535-65535 to developers to SSH into builds.

  3. Install Replicated, the tool used to package and distribute CircleCI Enterprise, by running the curl https://get.replicated.com/docker | sudo bash command. Note: Docker must not use the device mapper storage driver. Check this by running sudo docker info | grep "Storage Driver".)

  4. Visit port 8800 on the machine in a web browser to complete the guided installation process.

  5. Complete the process by choosing an SSL certificate option, uploading the license, setting the admin password and hostnames, enabling GitHub OAuth registration, and defining protocol settings. The application start up process begins by downloading the ~160 MB docker image, so it may take some time to complete.

  6. Open the CircleCI Enterprise app and click Get Started to authorize your GitHub account. The Add Projects page appears where you can select a project for your first build.