summaryrefslogtreecommitdiff
path: root/doc/ssh
diff options
context:
space:
mode:
authorkaren Carias <karen@gitlab.com>2015-09-23 13:43:57 -0700
committerkaren Carias <karen@gitlab.com>2015-09-23 13:43:57 -0700
commitcfcb5f0f6aac821ad5367645c994fbf7b8f41ea2 (patch)
treec4afe23c9461fccbb7d777053eaa752d82d07440 /doc/ssh
parent84d450bf4d94159529904be23f4056085629b1c1 (diff)
downloadgitlab-ce-cfcb5f0f6aac821ad5367645c994fbf7b8f41ea2.tar.gz
fixed step to instructions
Diffstat (limited to 'doc/ssh')
-rw-r--r--doc/ssh/README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/ssh/README.md b/doc/ssh/README.md
index 7b294a70fe7..b6b8000af4e 100644
--- a/doc/ssh/README.md
+++ b/doc/ssh/README.md
@@ -3,27 +3,27 @@
## SSH keys
An SSH key allows you to establish a secure connection between your
-computer and GitLab.
+computer and GitLab. Before generating an SSH key in your shell, check if your system
+already has one by running the following command:
+```bash
+cat ~/.ssh/id_rsa.pub
+```
-Before generating an SSH key, check if your system already has one by
-running `cat ~/.ssh/id_rsa.pub`. If you see a long string starting with
-`ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step.
+If you 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
+Note: 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.
+To generate a new SSH key, use the following command:
```bash
ssh-keygen -t rsa -C "$your_email"
```
+This command will prompt 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.
-Use the code below to show your public key.
-
+Use the command below to show your public key:
```bash
cat ~/.ssh/id_rsa.pub
```
@@ -32,7 +32,7 @@ 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.
-Use code below to copy your public key to the clipboard. Depending on your
+To copy your public key to the clipboard, use code below. Depending on your
OS you'll need to use a different command:
**Windows:**