From 39ad10f9fee0ed090e4da2a94d0c9fc8373e0d5a Mon Sep 17 00:00:00 2001 From: Jeff Blaine Date: Thu, 9 Apr 2015 20:36:46 -0400 Subject: [PATCH 1/2] Include non-default ssh key location info Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/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. --- doc/ssh/README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/doc/ssh/README.md b/doc/ssh/README.md index 0acf92fbf54..d6276cb0c4b 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -30,7 +30,7 @@ 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. +with your username and host. Use code below to copy your public key to the clipboard. Depending on your OS you'll need to use a different command: @@ -77,3 +77,29 @@ 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 +``` + +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 +``` + +Due to the wide variety of SSH clients and their very large number of configuration options, further explanation of this topic is beyond the scope of this document. From 06d2c09f95e8c53bdb9ad8b946f918d8a6e55202 Mon Sep 17 00:00:00 2001 From: Jeff Blaine Date: Wed, 15 Apr 2015 09:21:04 -0400 Subject: [PATCH 2/2] Show username SSH config example --- doc/ssh/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/ssh/README.md b/doc/ssh/README.md index d6276cb0c4b..5f44f9351dd 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -80,8 +80,7 @@ How to add your ssh key to Eclipse: http://wiki.eclipse.org/EGit/User_Guide#Ecli ## 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: +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: ``` # @@ -90,6 +89,7 @@ For OpenSSH clients, this is handled in the `~/.ssh/config` file with a stanza s Host gitlab.com RSAAuthentication yes IdentityFile ~/my-ssh-key-directory/my-gitlab-private-key-filename +User mygitlabusername ``` Another example @@ -102,4 +102,6 @@ RSAAuthentication yes IdentityFile ~/my-ssh-key-directory/company-com-private-key-filename ``` -Due to the wide variety of SSH clients and their very large number of configuration options, further explanation of this topic is beyond the scope of this document. +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.