Prerequisites

To add a project, you must have a GitHub or GitHub Enterprise account.

Adding a Project

Complete the following steps to set up a project on CircleCI Enterprise.

Navigate to the IP address in your browser for the CircleCI application as installed by your administrator. The Welcome page appears with a Get Started button.

Click the Get Started button on the Welcome to CircleCI page. If you are not already logged into GitHub, the Sign in to GitHub to continue to Local CCIE Enterprise page appears.

Enter your GitHub login credentials and click the Sign in button followed by your Two-factor authentication if appropriate. The CircleCI application appears with a Getting Started section.

Select or deselect projects from the list and click the Follow and Build button to start building your projects. The Builds page appears with your first project in the Running state.

To view the real-time build console and details, click the link to your build from the Builds page. The details page for your build appears. The Build Timing tab is shown in the following screenshot. Notice the red section of the timeline indicates where it failed.

Click the red section or scroll down to see the console error for the failure.

Now that your project is set up, every time you commit to your repo, CircleCI will run a new build. Note: It is possible to skip a build by including the keyword [ci skip] in your commit description to skip the build, see the Skip a Build documentation.

Troubleshooting and Customizing Configuration

If the build steps are not appropriate for your project, it is possible to add a circle.yml configuration file as described below. Add more projects at any time by clicking the Projects icon on the left sidebar in the CircleCI Enterprise app.
Following is a video walkthrough of the process to add a circle.yml file to your project:

Overriding or Adding Commands

Use a circle.yml file to override or add to the commands that CircleCI infers for your project.
You can find extensive documentation about the structure of this file and available
options in the Configuring CircleCI 1.0 document.

Unlike conventional CI servers that store the project configuration
on the CI server itself, CircleCI stores the configuration as code in the circle.yml
file. Storing
configuration in code is a great way of both tracking configuration versions and keeping
everything durably backed up independently of the CI server itself. CircleCI does not require a circle.yml file to build your project. If a circle.yml file is not found,
CircleCI will infer steps to run based on the structure of your project.

If you are migrating to CircleCI from Jenkins, you may also find the
Migrating from Jenkins to CircleCI helpful. Here’s another video that
covers the basics of adding a circle.yml file to your project repository

Debugging

CircleCI enables any developer to SSH into builds for their projects to debug problems.
Find instructions in the SSH build documentation.
Note: In CircleCI Enterprise, SSH access to builds may require connecting to a VPN, using a bastion
host, or following other special instructions specific to your installation. Consult your CircleCI
administrator if you are unable to access builds using SSH.

Using Parallelism

In addition to the conventional tools available for running tests in parallel using
multiple threads or processes, CircleCI allows you to run multiple containers with each build. These
containers are strongly isolated from each other using Linux Containers (LXC) which are very similar to Docker containers. Strong isolation eliminate many
common errors that occur in other parallel test runners, for example, unintentional sharing of files and databases.

Many common test runners like nose and RSpec run automatically and in parallel according to the test commands that CircleCI infers from your project. In these cases, test runtime data can also be collected to ensure that tests are split up
optimally. You can read about how to ensure tests are auto-balanced in the Collecting Test Metadata document for CircleCI 1.0.

Installing Custom Packages

CircleCI enables you to use sudo, apt-get, and more. Unlike other CI servers that require you to work with an administrator
to install any custom packages, CircleCI Enterprise allows you to install dependencies
by using your circle.yml file. Find some examples of installing custom software in the CircleCI 1.0
Customizing Build Environments document.

Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.