Commit d0b87eb05b71ee0fe2ff5385ef6047b032feb3e1
Exists in
spb-stable
and in
3 other branches
Merge branch 'ssh-docs' into 'master'
Ssh Docs
Showing
1 changed file
with
13 additions
and
2 deletions
Show diff stats
app/views/help/ssh.html.haml
| @@ -5,13 +5,24 @@ | @@ -5,13 +5,24 @@ | ||
| 5 | SSH key allows you to establish a secure connection between your computer and GitLab | 5 | SSH key allows you to establish a secure connection between your computer and GitLab |
| 6 | 6 | ||
| 7 | %p.slead | 7 | %p.slead |
| 8 | - To generate a new SSH key just open your terminal and use code below. Press enter to accept the defaults when generating the key. | 8 | + Before generating an SSH key, check if your system already has one by running cat ~/.ssh/id_rsa.pub |
| 9 | + If your see a long string starting with 'ssh-rsa' or 'ssh-dsa', you can skip the ssh-keygen step. | ||
| 10 | + | ||
| 11 | + %p.slead | ||
| 12 | + 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. | ||
| 13 | + When prompted for the location and filename you can press enter to use the default. | ||
| 14 | + 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. | ||
| 15 | + Note that the password you choose here can't be altered or retrieved. | ||
| 9 | 16 | ||
| 10 | %pre.dark | 17 | %pre.dark |
| 11 | ssh-keygen -t rsa -C "#{current_user.email}" | 18 | ssh-keygen -t rsa -C "#{current_user.email}" |
| 12 | 19 | ||
| 13 | %p.slead | 20 | %p.slead |
| 14 | - Next just use code below to dump your public key and add to GitLab SSH Keys | 21 | + Use code below to show your public key. |
| 15 | 22 | ||
| 16 | %pre.dark | 23 | %pre.dark |
| 17 | cat ~/.ssh/id_rsa.pub | 24 | cat ~/.ssh/id_rsa.pub |
| 25 | + | ||
| 26 | + %p.slead | ||
| 27 | + Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your user profile. | ||
| 28 | + Please copy the complete key starting with 'ssh-' and ending with your username and host. |