Checking your Server Instance

Cloud

realitycheck is a CircleCI repository that can be used to validate the basic features of a hosted CircleCI installation.

To run the realitycheck, fork the repository and start building it on your installation of CircleCI. See Projects and Builds in our documentation or How to Get Started on CircleCI on YouTube for guidance on adding a new project to CircleCI.

GitHub Enterprise

If your organization uses GitHub Enterprise rather than github.com, you will need to first create an empty repository in GitHub Enterprise and then add the realitycheck to it.

To do so, either clone your new repository to your local machine, pull in our repository, and then push it back to GHE (see below); or else download realitycheck as a .zip file, expand it, and then upload the contents of the resultant realitycheck-master directory to your new GHE repository via the GitHub Enterprise UI, making sure to include hidden files (CircleCI configuration files live in a .circleci directory that is hidden by default on most operating systems).

Adding realitycheck to GitHub Enterprise via the CLI

git pull git@github.com:circleci/realitycheck.git && cd realitycheck
git remote set-url origin <your-ghe-repo-url>
git push

Additional Notes

To successfully run realitycheck, you will need to configure certain environment variables and generate a CircleCI API token—see the repository's README for details. The README also contains further information about which specific features are tested, and how they are tested.