SSH keys are required in order to provide secure connection with the remote git host specified in the Repository Origin field. The git add-on uses one set of keys for accessing all configured repositories.
There are two options available for specifying SSH keys:
Both types of SSH keys are displayed on the SSH Keys tab. Legacy filesystem-based keys contain directory path in the Private key column.
Generated ssh keys always come in pair. (Example:
For establishing safety connection with SSH, upload a Public Key to the SSH server and set the Private Key to the SSH client.
Take note that the SSH server is the Git server and the SSH client is the Jira server.
For OSX/MacOS, this generates an SSH key on Mac in RSA format:
ssh-keygen -t rsa -b 4096 -m pem -C "firstname.lastname@example.org"
Configure and generate SSH keys for the following git hosting systems by following the reference links on each sub-section:
By v2.6.1 of the Git add-on, the Gerrit web linking support is added.
The SSH support starts with TFS 2013 and later versions.
Go to Administration > Add-ons. Click Manage Add-ons on the sidebar. Under Git Integration Plugin for Jira, select SSH Keys.
|Name||Name of the added SSH key|
|Private key||This is the SSH key in hex mode.|
|Passphrase||Defines true if the SSH key has a passphrase.|
|Associations||Lists the associated repositories with this SSH key.|
|Last Used By||Defines the repository that is using this SSH key.|
|Operations||Click the icon to perform Delete and Associations functions.|
Click Add SSH Key to configure the SSH key. The following screen is displayed:
Utilize the following options for the new SSH key:
|Name||Enter a meaningful name for this private SSH key.|
|Private key|| This is the actual private SSH key.
Paste private key from clipboard or load from a private key file.
|Passphrase||Optional. Enter the passphrase that you have assigned to this private key.|
Limit the usage of the SSH key only to the selected repositories. As of v2.6.9 of the Git add-on, the option to strictly map keys to repositories is available.
On the SSH Keys page, click Actions > Associations for the selected SSH key.
The following screen is displayed:
Mark the required repository or repositories to associate the SSH key.
Clicking thetext label marks all repositories that will be associated to this SSH key.
Clicking thetext label deselects all repositores.
Click Save to save the settings.
If you have multiple repositories that uses the same SSH key that you want to connect with the Git add-on, you need to:
For third-party products or services (such as GitHub, GitLab, Bitbucket, etc.), register the PUBLIC KEY for target repository or in profile settings of your git account.
For custom git hosting servers, ask your administrator to check that the target
keypair's PUBLIC KEY is added into the
authorized_keys file of
the git server. For more information, see the following article:
SSH keys cannot be modified or updated. To change the keys, remove and add them again.
Perform the following steps to reconfigure repositories and SSH key:
For multiple repository configuration, see Bulk Change.