Merge branch 'sshdoc' into 'master'
Include non-default ssh key location info Fixes #875 Provide help for people who aren't SSH-clued by indicating how to point to key files that have been named something other than the default. A lot of people seem to assume that the filename they choose is irrelevant and then wonder why their private key is not being found by simple 'ssh' commands. See merge request !507
This commit is contained in:
commit
cbb1353b28
1 changed files with 29 additions and 1 deletions
|
@ -77,3 +77,31 @@ information.
|
|||
### Eclipse
|
||||
|
||||
How to add your ssh key to Eclipse: http://wiki.eclipse.org/EGit/User_Guide#Eclipse_SSH_Configuration
|
||||
|
||||
## Tip: Non-default OpenSSH key file names or locations
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
#
|
||||
# Main gitlab.com server
|
||||
#
|
||||
Host gitlab.com
|
||||
RSAAuthentication yes
|
||||
IdentityFile ~/my-ssh-key-directory/my-gitlab-private-key-filename
|
||||
User mygitlabusername
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
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.
|
||||
|
|
Loading…
Reference in a new issue