If you want to change the password of your key later, you can use the following
### Provide a file path
command: `ssh-keygen -p <keyname>`
Use the command below to show your public key:
You will be prompted to input a file path to save your key pair to.
**Windows Command Line:**
If you don't already have an SSH key pair use the suggested path by pressing enter.
```bash
Using the suggested path will allow your SSH client
type %userprofile%\.ssh\id_rsa.pub
to automatically use the key pair with no additional configuration.
```
**GNU/Linux/Mac/PowerShell:**
If you already have a key pair with the suggested file path you will need to input a new file path
```bash
and declare what host this key pair will be used for in your `.ssh/config` file,
cat ~/.ssh/id_rsa.pub
see **Working with non-default SSH key pair paths** for more information.
```
### Provide a password
Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your
Once you have input a file path you will be prompted to input a password to secure your SSH key pair.
user profile. Please copy the complete key starting with `ssh-rsa` and ending
Note: It is a best practice to use a password for an SSH key pair,
with your username and host.
but it is not required and you can skip creating a password by pressing enter.
To copy your public key to the clipboard, use the code below. Depending on your
If you want to change the password of your key, you can use the following command:
OS you'll need to use a different command:
`ssh-keygen -p <keyname>`
## Copying your public SSH key to the clipboard
To copy your public key to the clipboard, use the appropriate code for you operating system below:
**Windows Command Line:**
**Windows Command Line:**
```bash
```bash
...
@@ -70,6 +91,48 @@ pbcopy < ~/.ssh/id_rsa.pub
...
@@ -70,6 +91,48 @@ pbcopy < ~/.ssh/id_rsa.pub
xclip -sel clip < ~/.ssh/id_rsa.pub
xclip -sel clip < ~/.ssh/id_rsa.pub
```
```
## Adding your public SSH key to GitLab
Navigate to the 'SSH Keys' tab in you 'Profile Settings'.
Paste your key in the 'Key' section and give it a relevant 'Title'.
Use an identifiable title like 'Work Laptop - Windows 7' or 'Home MacBook Pro 15'.
If you manually copied your public SSH key make sure you copied the entire key
starting with `ssh-rsa` and ending with your email.
## Working with non-default SSH key pair paths
If you used a non-default file path for your GitLab SSH key pair,
you must configure your SSH client to find your GitLab SSH private key
for connections to your GitLab server (perhaps gitlab.com).
For OpenSSH clients this is configured in the `~/.ssh/config` file.
Below are two example host configurations using their own key:
```
# GitLab.com server
Host gitlab.com
RSAAuthentication yes
IdentityFile ~/folder1/private-key-filename
User mygitlabusername
# Private GitLab server
Host gitlab.company.com
RSAAuthentication yes
IdentityFile ~/folder2/private-key-filename
```
Note in the gitlab.com example above a username was specified
to override the default chosen by OpenSSH (your local username).
This is only required if your local and remote usernames differ.
Due to the wide variety of SSH clients and their very large number of configuration options,
further explanation of these topics is beyond the scope of this document.
Public SSH keys need to be unique, as they will bind to your account.
Your SSH key is the only identifier you'll have when pushing code via SSH.
That's why it needs to uniquely map to a single user.
## Deploy keys
## Deploy keys
Deploy keys allow read-only access to multiple projects with a single SSH
Deploy keys allow read-only access to multiple projects with a single SSH
...
@@ -99,34 +162,3 @@ Deploy keys can be shared between projects, you just need to add them to each pr
...
@@ -99,34 +162,3 @@ Deploy keys can be shared between projects, you just need to add them to each pr
### Eclipse
### Eclipse
How to add your ssh key to Eclipse: https://wiki.eclipse.org/EGit/User_Guide#Eclipse_SSH_Configuration
How to add your ssh key to Eclipse: https://wiki.eclipse.org/EGit/User_Guide#Eclipse_SSH_Configuration
## Tip: Non-default OpenSSH key file names or locations
If, for whatever reason, you decide to specify a non-default location and filename for your GitLab SSH key pair, you must configure your SSH client to find your GitLab SSH private key for connections to your GitLab server (perhaps gitlab.com). For OpenSSH clients, this is handled in the `~/.ssh/config` file with a stanza similar to the following:
Note in the gitlab.com example above a username was specified to override the default chosen by OpenSSH (your local username). This is only required if your local and remote usernames differ.
Due to the wide variety of SSH clients and their very large number of configuration options, further explanation of these topics is beyond the scope of this document.
Public SSH keys need to be unique, as they will bind to your account. Your SSH key is the only identifier you'll
have when pushing code via SSH. That's why it needs to uniquely map to a single user.
