summaryrefslogtreecommitdiff
path: root/doc/ssh
diff options
context:
space:
mode:
authorJeroen van Baarsen <jeroenvanbaarsen@gmail.com>2014-02-13 11:55:46 +0100
committerJeroen van Baarsen <jeroenvanbaarsen@gmail.com>2014-02-28 19:30:13 +0100
commit564c37d9b69367fb7384a22edad53c8e75aeb2cb (patch)
tree8466be03d9e579fb89c26f2d5e4490b6296becae /doc/ssh
parent049d0cc396669d7b970fc3d23e87eb62b3e57b75 (diff)
downloadgitlab-ce-564c37d9b69367fb7384a22edad53c8e75aeb2cb.tar.gz
Moved all the help files to markdown files:
Files moved: * Workflow * help/ssh * help/webhooks * help/system_hooks * help/public_access * help/permissions
Diffstat (limited to 'doc/ssh')
-rw-r--r--doc/ssh/ssh.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/ssh/ssh.md b/doc/ssh/ssh.md
new file mode 100644
index 00000000000..0a38bc16b49
--- /dev/null
+++ b/doc/ssh/ssh.md
@@ -0,0 +1,24 @@
+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.