Skip to main content

Configuring SSH keys

Abstract

To access your app's repository, Bitrise needs an SSH key. You can add an SSH key when you first add an app to Bitrise but you can update your keys at any point in App settings.

SSH keys are the primary method of authentication. To access your app's repository, Bitrise needs a public-private SSH keypair, with the public key registered to your app's Git repository.

You can add an SSH key when you first add an app to Bitrise but you can update your keys at any point. You can even skip SSH key configuration when adding the app and register SSH keys later.

Generating your own SSH key

You can generate your own SSH keypair with a simple Command Line/Terminal command:

ssh-keygen -t rsa -b 4096 -P '' -f ./bitrise-ssh -m PEM

This will generate two files in the current directory (the directory where you run the command):

  • bitrise-ssh (private key)

  • bitrise-ssh.pub (public key)

You should copy paste the public key to your Git hosting service (GitHub, Bitbucket, etc.), and when you register your app on bitrise.io, you’ll have to provide the private key.

To configure SSH keys on bitrise.io:

Admin access only

Only users with the role of admin on the app's team can access all functions of the App Settings page of an app.

  1. Open your app on Bitrise.

  2. Click on App Settings.

  3. Find the SSH settings section.

  4. Click Change SSH keypair.

    If you haven't had an SSH key added before, the button will show Add SSH keypair instead.

    ssh_keypair.png
  5. Choose from one of three options:

    • Generate SSH keypair and auto-add it to GitHub: Bitrise automatically registers a public SSH key to your GitHub repository. Choose this if you have administrator rights to the repository.

    • Generate SSH keypair: Bitrise generates an SSH keypair for you, and you have to manually register the public key to your Git repository.

    • Use your own SSH keypair: You provide your own SSH keypair for authentication, and you have to manually register the public key to your Git repository.