README.md 3.87 KB
Newer Older
1
2
# SSH

3
4
5
## SSH keys

An SSH key allows you to establish a secure connection between your
karen Carias's avatar
karen Carias committed
6
7
8
9
10
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
```
11

karen Carias's avatar
karen Carias committed
12
If you see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the `ssh-keygen` step.
13

karen Carias's avatar
karen Carias committed
14
Note: It is a best practice to use a password for an SSH key, but it is not
15
16
17
required and you can skip creating a password by pressing enter. Note that
the password you choose here can't be altered or retrieved.

karen Carias's avatar
karen Carias committed
18
To generate a new SSH key, use the following command:
19
20
21
```bash
ssh-keygen -t rsa -C "$your_email"
```
karen Carias's avatar
karen Carias committed
22
23
24
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.
25

karen Carias's avatar
karen Carias committed
26
Use the command below to show your public key:
27
28
29
30
31
32
```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
33
with your username and host.
34

karen Carias's avatar
karen Carias committed
35
To copy your public key to the clipboard, use code below. Depending on your
36
37
38
39
40
41
42
43
44
45
46
47
OS you'll need to use a different command:

**Windows:**
```bash
clip < ~/.ssh/id_rsa.pub
```

**Mac:**
```bash
pbcopy < ~/.ssh/id_rsa.pub
```

48
**GNU/Linux (requires xclip):**
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
```bash
xclip -sel clip < ~/.ssh/id_rsa.pub
```

## Deploy keys

Deploy keys allow read-only access to multiple projects with a single SSH
key.

This is really useful for cloning repositories to your Continuous
Integration (CI) server. By using deploy keys, you don't have to setup a
dummy user account.

If you are a project master or owner, you can add a deploy key in the
project settings under the section 'Deploy Keys'. Press the 'New Deploy
Key' button and upload a public SSH key. After this, the machine that uses
the corresponding private key has read-only access to the project.

You can't add the same deploy key twice with the 'New Deploy Key' option.
If you want to add the same key to another project, please enable it in the
list that says 'Deploy keys from projects available to you'. All the deploy
keys of all the projects you have access to are available. This project
71
access can happen through being a direct member of the project, or through
72
73
a group. See `def accessible_deploy_keys` in `app/models/user.rb` for more
information.
74

karen Carias's avatar
karen Carias committed
75
Deploy keys can be shared between projects, you just need to add them to each project.
karen Carias's avatar
karen Carias committed
76

77
78
79
80
81
## Applications

### Eclipse

How to add your ssh key to Eclipse: http://wiki.eclipse.org/EGit/User_Guide#Eclipse_SSH_Configuration
82
83
84

## Tip: Non-default OpenSSH key file names or locations

Jeff Blaine's avatar
Jeff Blaine committed
85
If, for whatever reason, you decide to specify a non-default location and filename for your Gitlab SSH key pair, you must configure your SSH client to find your Gitlab SSH private key for connections to your Gitlab server (perhaps gitlab.com). For OpenSSH clients, this is handled in the `~/.ssh/config` file with a stanza similar to the following:
86
87
88
89
90
91
92
93

```
#
# Main gitlab.com server
#
Host gitlab.com
RSAAuthentication yes
IdentityFile ~/my-ssh-key-directory/my-gitlab-private-key-filename
Jeff Blaine's avatar
Jeff Blaine committed
94
User mygitlabusername
95
96
97
98
99
100
101
102
103
104
105
106
```

Another example
```
#
# Our company's internal Gitlab server
#
Host my-gitlab.company.com
RSAAuthentication yes
IdentityFile ~/my-ssh-key-directory/company-com-private-key-filename
```

Jeff Blaine's avatar
Jeff Blaine committed
107
108
109
Note in the gitlab.com example above a username was specified to override the default chosen by OpenSSH (your local username). This is only required if your local and remote usernames differ.

Due to the wide variety of SSH clients and their very large number of configuration options, further explanation of these topics is beyond the scope of this document.
110
111
112

Public SSH keys need to be unique, as they will bind to your account. Your SSH key is the only identifier you'll
have when pushing code via SSH. That's why it needs to uniquely map to a single user.