From a91faf40221fc574513f7e17a93a0a5a941b8fce Mon Sep 17 00:00:00 2001 From: dosire Date: Thu, 23 Jan 2014 12:07:21 +0100 Subject: Better ssh key docs. --- app/views/help/ssh.html.haml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/app/views/help/ssh.html.haml b/app/views/help/ssh.html.haml index 773e490ef80..5d35d18c986 100644 --- a/app/views/help/ssh.html.haml +++ b/app/views/help/ssh.html.haml @@ -5,13 +5,19 @@ SSH key allows you to establish a secure connection between your computer and GitLab %p.slead - To generate a new SSH key just open your terminal and use code below. Press enter to accept the defaults when generating the key. + 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. + + %p.slead + 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/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 the step by pressing enter. Note that the password you choose here can't be altered or retrieved. %pre.dark ssh-keygen -t rsa -C "#{current_user.email}" %p.slead - Next just use code below to dump your public key and add to GitLab SSH Keys + Use code below to show your public key. %pre.dark cat ~/.ssh/id_rsa.pub + + %p.slead + 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. -- cgit v1.2.1 From f909739f396e71895829955f40ced755f4fbe772 Mon Sep 17 00:00:00 2001 From: dosire Date: Thu, 23 Jan 2014 13:28:19 +0100 Subject: Split into one sentence per line for future edits. --- app/views/help/ssh.html.haml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/app/views/help/ssh.html.haml b/app/views/help/ssh.html.haml index 5d35d18c986..1c7b08aa7cd 100644 --- a/app/views/help/ssh.html.haml +++ b/app/views/help/ssh.html.haml @@ -5,10 +5,14 @@ SSH key allows you to establish a secure connection between your computer and GitLab %p.slead - 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. + 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. %p.slead - 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/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 the step by pressing enter. Note that the password you choose here can't be altered or retrieved. + 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. %pre.dark ssh-keygen -t rsa -C "#{current_user.email}" @@ -20,4 +24,5 @@ cat ~/.ssh/id_rsa.pub %p.slead - 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. + 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. -- cgit v1.2.1