gitlab-org--gitlab-foss/doc/ssh/ssh.md

# SSH keys

SSH key allows you to establish a secure connection between your computer and GitLab

Before generating an SSH key, check if your system already has one by running `cat ~/.ssh/id_rsa.pub` If your see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step.

To generate a new SSH key just open your terminal and use code below. The ssh-keygen command prompts you for a location and filename to store the key pair and for a password. When prompted for the location and filename you can press enter to use the default. 
It is a best practice to use a password for an SSH key but it is not required and you can skip creating a password by pressing enter. 
Note that the password you choose here can't be altered or retrieved.

```bash
ssh-keygen -t rsa -C "$your_email"
```

Use the code below to show your public key.

```bash
cat ~/.ssh/id_rsa.pub
```

Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your user profile. Please copy the complete key starting with `ssh-` and ending with your username and host.
Add titles to doc pages. 2014-05-27 08:12:15 -04:00			`# SSH keys`

Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00			`SSH key allows you to establish a secure connection between your computer and GitLab`

Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			Before generating an SSH key, check if your system already has one by running `cat ~/.ssh/id_rsa.pub` If your see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step.
Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00
Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			`To generate a new SSH key just open your terminal and use code below. The ssh-keygen command prompts you for a location and filename to store the key pair and for a password. When prompted for the location and filename you can press enter to use the default.`
Moved all the help files to markdown files: Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions 2014-02-13 05:55:46 -05:00			`It is a best practice to use a password for an SSH key but it is not required and you can skip creating a password by pressing enter.`
			`Note that the password you choose here can't be altered or retrieved.`

			```bash
			`ssh-keygen -t rsa -C "$your_email"`
			```

			`Use the code below to show your public key.`

			```bash
			`cat ~/.ssh/id_rsa.pub`
			```

Update docs to markdown style guide. 2014-04-24 18:48:22 -04:00			Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your user profile. Please copy the complete key starting with `ssh-` and ending with your username and host.