The recommended platform for Code Climate: Enterprise (CC:E) is Amazon Web Services (AWS). This provides the best experience for operating and maintaining the system on full-featured cloud platform. Using this guide, deployment of a new CC:E installation usually takes around an hour.
Can't deploy to Amazon Web Services?
Other deployment options may be possible. Please contact us to discuss further.
Prior to starting installation of CC:E, you will need:
A CC:E License File (.rli)
This will be provided by our team prior to installation. If you need a CC:E license, please contact us.
A DNS hostname where your instance of Code Climate can be reached by your organization
Typically your hostname will look something like https://codeclimate.YOURDOMAIN.com. Your SSL certificate needs to be configured with this URL.
SSL certificate information
Either provide a PEM encoded cert file and .key file or use the provided self-signed certificate.
Your SMTP server settings
Including the type of authentication, server name and credentials
A Code Climate client application on GitHub (github.com or GitHub Enterprise)
Follow the steps outlined in GitHub: Creating a Code Climate GitHub Client Application. During installation you will be prompted for your GitHub Enterprise URL (if using GitHub Enterprise) as well as the Client ID and Client Secret for the application you create.
A VPC and Subnet configured on AWS
You will need to input these during the installation process
- Visit bit.ly/code-climate-cf. This will take you to the AWS CloudFormation setup flow. At the first page, just hit Next.
- Fill in the
KeyNameof the key you want to use to access your CC:E instance. Make sure that
Datais at least 250 GB. Also fill in the VPC and Subnet IDs
- Adjust tags and other options based on your existing AWS conventions.
- Create the Stack.
- Once stack creation is complete, point your selected DNS name at your instance. If you are using Route 53, add a
CNAMEalias record pointing to the DNS name for your instance.
Finding your CC:E DNS Name
To find the DNS name of the EC2 instance created during setup, click on the "Outputs" tab in the stack output page. The field next to
SoloDNS is the DNS name for the instance.
The management interface should now be available at your DNS address, on port 8800, over the HTTPs protocol.
You can proceed past the HTTPs connection security warning which will be presented. CC:E uses a self-signed certificate initially.
Example on Google Chrome of a security warning you will see as a result of using a self-signed certificate.
Upload a custom TLS/SSL cert/key (PEM encoded) or proceed with the provided self-signed pair.
A license file will be provided by a Code Climate representative prior to installation.
Check your email for your license activation code and enter it into the provided box.
Example email with activation code
Provide your activation code here.
Provide a password or connect to your LDAP server
Next you'll be presented with a variety of Code Climate Enterprise settings, such as SMTP credentials and GitHub integration information. Provide the information requested and click "Save" to continue.
Click "Start now" to boot Code Climate Enterprise.
Click "Start now" to boot Code Climate Enterprise. You will be taken to the dashboard of the Code Climate Management Interface while the instance boots up.
This boot process involves the VM fetching Docker images for all of Code Climate's services, and can take some time.
Initial Installs & Upgrades
Initial installs & upgrades can spend 30 minutes or more in the Starting and Queued states, as this is when all of the new or upgraded Code Climate services used for analysis are populated in the system.
Once the instance has finished booting, an "open" link will appear on the far left side. Click "open" to launch Code Climate Enterprise in a new browser window.
First page load
Because the application isn't fully booted yet, the first page load of Code Climate Enterprise typically takes a few seconds. This is completely normal, be patient!
The first user to log in to the Code Climate organization will automatically be granted administrative access. To log in as an administrator you'll need to create a new Code Climate user by clicking Sign up.
When creating a new user you have two options:
- authenticate via your GitHub credentials
- sign up with an email and password combination