How to Configure SSH Keys in GitKraken

Edited 3 days ago by ExtremeHow Editorial Team

GitKrakenSSHKeysConfigurationGitAuthenticationSecurityVersion ControlRepositoryWorkflow

Secure Shell (SSH) keys are a secure way to authenticate your identity over a network. They are commonly used in various applications related to server management and version control systems, including Git. GitKraken, a popular Git client, allows users to easily manage repositories with SSH keys. This guide provides a detailed explanation on how to configure SSH keys in GitKraken.

Understanding SSH keys

SSH keys consist of a pair of cryptographic keys: a private key and a public key. As the name suggests, the private key must be kept confidential and stored securely. The public key can be shared with anyone you want to gain access to your system or services. When SSH keys are used, the system verifies the user's identity through the public key, allowing them to access the server without entering a password.

In the context of Git, SSH keys are used to establish secure connections between your local machine and a Git remote server such as GitHub, GitLab or Bitbucket. They enable you to push and pull code securely and efficiently.

Generating SSH keys

Before you can configure SSH keys in GitKraken, you need to generate an SSH key pair on your local machine. Here's how you can do it:

Step 1: Open the terminal

To create SSH keys, you will need access to the terminal (command line interface) on your operating system. Here's how to open it:

• Windows: Use the Command Prompt or PowerShell.
• macOS: Open the Terminal app.
• Linux: Open a terminal through your desktop environment or by using a shortcut such as Ctrl + Alt + T.

Step 2: Generate SSH key pair

Use ssh-keygen tool to create a new SSH key pair. Execute the following command:

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

-t option specifies the type of key to be created, which in this case is RSA. -b option specifies the number of bits in the key, making it more secure. -C option is used to add a label to your key, usually your email address.

Step 3: Save the key

After running the command, you'll be prompted to select a location to save the key. By default, it is saved in the .ssh directory within your home directory. Press Enter to confirm the default location or specify a custom path if desired. You'll then be prompted to enter a passphrase for added security, which is optional but recommended.

Step 4: Retrieve the public key

Once generated, you must add the public key to your version control hosting service. To retrieve it, use the following command:

cat ~/.ssh/id_rsa.pub

Copy the output, which is your public key.

Adding SSH keys to the remote service

Next, add your public key to the hosting service for your Git repository (GitHub, GitLab, Bitbucket, etc.). This step allows the server to recognize your machine when you try to access the repository.

GitHub example

• Log in to your GitHub account.
• Navigate to Settings → SSH & GPG Keys → New SSH Key.
• Paste your public key into the field provided.
• Give your key a meaningful title.
• Click Add SSH key.

Configuring GitKraken with SSH Keys

Once your SSH key is ready and added to your remote service, you can configure GitKraken to use it:

Step 1: Open GitKraken

Launch GitKraken on your local machine. If you haven't installed it yet, download it from GitKraken's official website and follow the installation instructions for your operating system.

Step 2: Access preferences

In GitKraken, access the preferences by clicking the profile icon in the upper right corner of the application window. From the dropdown menu, select Preferences.

Step 3: Go to SSH preferences

In the Preferences window, select the Authentication tab on the left. In the Authentication options, find the section for SSH.

Step 4: Add the SSH key

GitKraken can automatically detect existing SSH keys from your .ssh directory. If the generated key doesn't appear, click Generate or Add Existing. If adding an existing key, browse to the location of your private SSH key (e.g., ~/.ssh/id_rsa) and select it.

If selecting to generate a new key, GitKraken will create a key and add it to its internal credential management system.

Step 5: Test the SSH connection

After configuration, test the SSH connection to make sure GitKraken can communicate with the remote repository. To do this, open the repository in GitKraken and perform actions such as pull and push. If successful, your SSH key is properly configured.

Troubleshooting

If you encounter any problems during setup, here are some common problems and solutions:

Permission denied (publickey)

This error occurs when the SSH key is not correctly associated with your Git server account or is not loaded by your SSH agent.

• Make sure your SSH key is correctly added to your Git server.
• Verify that the SSH agent is running, and that your private key is loaded.
• Use ssh-add ~/.ssh/id_rsa on your terminal to add it to the agent.

SSO required

If the service requires single sign-on authentication, it may request additional authentication methods beyond SSH keys. See the platform's documentation or support channels for specific instructions.

SSH agent issues

Sometimes, problems arise from the SSH agent used to manage the keys.

• Make sure your SSH agent is running by checking the running processes or using a command like eval $(ssh-agent).
• Make sure your key is added using ssh-add.

Incorrect file permissions

SSH will not use key files that are freely accessible.

• Use chmod 600 ~/.ssh/id_rsa to set the correct permissions for the private key.

Conclusion

Configuring SSH keys in GitKraken is a straightforward process that provides increased security and streamlined access to Git repositories. By creating a secure SSH key pair and connecting it to your chosen Git hosting platform, you ensure that your version control operations become seamless and secure. SSH keys remove the constant need to input passwords, instead allowing cryptographic verification based on already established security.

As you progress working with GitKraken, enjoy the improved efficiency and security that SSH keys bring to your development workflow.

  Share This Article

If you find anything wrong with the article content, you can request an update