icon

Activate SSH key (RSA private key)

Add your SSH key to the build machine to access private repositories

This Step makes sure Bitrise has access to your repository when cloning SSH URLs. The Step saves the provided private key of your SSH keypair to a file and then loads it into the SSH agent.

Configuring the Step

By default, you do not have to change anything about the Step's configuration.

The step downloads the SSH key defined in your App Settings, so most of the time it's the only thing you need to configure (more info.

All you need to do is make sure that you registered your key pair on Bitrise and the public key at your Git provider. You can generate and register an SSH keypair in two ways.

  • Automatically during the app creation process.
  • Manually during the app creation process or at any other time. You generate your own SSH keys and register them on Bitrise and at your Git provider. The SSH key should not have a passphrase!

Note: if you configure to use HTTPS instead of SSH git access, you don't need to use this Step.

Troubleshooting

If the Step fails, check the public key registered to your Git repository and compare it to the public key registered on Bitrise. The most frequent issue is that someone deleted or revoked the key on your Git provider's website.

You can also set the Enable verbose logging input to true. This provides additional information in the log.

Useful links

Related Steps

Similar steps

Installs a service account key to your pipeline before build time

Sets specified NuGet private source to the NuGet source list for the next build.

Adds your authentication configuration to the .netrc file.

Establish a VPN connection with the specified OpenVPN server.