SSH support for custom git connections

SSH support for custom git connections

Gabriel Cowley on

Share with


For quite a while now, Gearset has supported integration with source control platforms via OAuth or via a custom git connection that uses a username and password to authenticate via HTTPS. You can find more details on this feature here. While the existing feature covered most of the required scenarios for integrating your git repositories with Gearset, some of our users requested SSH support for custom git connections. We’re therefore pleased to announce that the latest release of Gearset supports SSH for custom git connections. Below are a few simple instructions on how to set up an SSH-based custom git connection.

Live eventConvene, Chicago

DevOps Dreamin’ Chicago 2024

Find out more

Set up an SSH custom git connection

  1. Go to the Manage source control page of the Gearset app.

  2. In the Manage custom git repositories section, click the Add new custom git repository button.

    Manage custom git repositories
  3. In the Authentication type, select SSH.

  4. In the Repo address field, enter the SSH address of your chosen git repository.

  5. If you are adding an SSH custom git repository for the first time, a key pair will not yet have been generated for you. If this is the case, click the Generate SSH key pair link below the Public key field.

    Generate key pair
  6. Once the key pair has been generated, copy the SSH public key and register it with whichever git provider you are using. An example of how to do this with GitHub is given below.

  7. Click the Test connection button to verify the connection to your repository.

  8. Click Add repository.

Your connection will now be listed in the Manage custom git repositories section.

Register an SSH public key with GitHub

If you’re using GitHub as your git hosting provider, then follow the steps below to register your SSH public key with GitHub. The process is similar if you’re using one of the other main repository hosting platforms.

  1. While logged into GitHub, click the user icon on the top right to display a dropdown menu.
  2. In this dropdown, click Settings.
  3. In the Personal settings column on the left-hand side, click SSH and GPG keys.
  4. In the SSH keys section, click the New SSH key button.
  5. In the Title field, enter whatever name you like to identify this particular public key (“Gearset” might be a suitable title in this case).
  6. In the Key field, paste the SSH public key that you copied from the Add new linked Git repository pop-up window in Gearset.
  7. Click Add SSH key.

Get started with Gearset today

Want to try setting up version control for Salesforce? If you haven’t already, start your free 30-day trial of Gearset today and build an end-to-end DevOps process. You might also want to read our free whitepaper on version control for Salesforce.

Try all of Gearset for free