Introduction

SSH (Secure Shell) integration in CodeSensor enhances secure communication with your organization's version control systems (VCS). To use SSH with CodeSensor, you must first generate a key and register its public component in your VCS. This guide provides step-by-step instructions for registering SSH keys in supported VCS platforms. The SSH keys generated by Cranium utilize RSA2 encryption with a 4096-bit key size for robust security.

Generate SSH Public Key

To enable SSH, navigate to the Integration Manager section in Cranium. Open the navigation drawer, select Settings and click on Integrations. Locate the integration for which you want to enable SSH, and click the three-dot kebab menu. Select Enable SSH from the action menu. In the SSH Public Key modal, click the blue Enable SSH Key button to generate your SSH key. Use the blue Copy button to copy the generated key.

Register SSH Key

Azure DevOps

Navigate to SSH Public Keys Settings

Log in to your Azure DevOps site and click the User Settings icon in the top navigation bar. From the dropdown, select SSH public keys to access the configuration page.

Add a New SSH Key

On the SSH Public Keys page, click the blue New Key button. Assign a unique name to the key and paste the SSH key copied from Cranium. Once completed, click the blue Add button to register the key.

GitHub

Navigate to User Settings

Open your GitHub site and click the Profile icon in the top navigation bar. From the menu, select Settings.

Add a New SSH Key

Under the Access section in the left navigation bar, click SSH and GPG keys. Then, click the green New SSH key button to open the configuration page. Provide a title for the key, confirm the key type is set to Authentication Key, and paste the SSH key copied from Cranium. Finally, click the green Add SSH key button.

Bitbucket Data Center & Cloud

Log in to your Bitbucket account, click the Settings icon in the top navigation bar, and select Personal Bitbucket settings from the menu.

Add a New SSH Key

In the left navigation bar, select SSH keys. Click the blue Add key button to open the configuration page. Provide a unique label for the key, paste the SSH key copied from Cranium, and click Add key to complete the setup.

GitLab

Navigate to User Settings

Log in to your GitLab account and click the Profile icon in the top-right corner of the left navigation menu. Select Preferences from the dropdown.

Add a New SSH Key

In the left navigation menu, click SSH keys. Then, click the Add new key button to open the form. Paste the SSH key copied from Cranium in the Key field, assign a title, and set an expiration date, if needed. Click the blue Add key button to register the key.

Disable SSH

To disable SSH, navigate to the Integration Manager in Cranium. Click the three-dot kebab menu next to the desired integration and select Enable SSH from the action menu. In the modal, click the red Disable SSH button to turn off the SSH connection.