diff options
Diffstat (limited to 'doc/ssh/index.md')
| -rw-r--r-- | doc/ssh/index.md | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/ssh/index.md b/doc/ssh/index.md index 2fae3512b9d..6196ee5465b 100644 --- a/doc/ssh/index.md +++ b/doc/ssh/index.md @@ -1,14 +1,14 @@ --- stage: Manage -group: Access +group: Authentication & Authorization info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments" type: howto, reference --- -# GitLab and SSH keys **(FREE)** +# Use SSH keys to communicate with GitLab **(FREE)** Git is a distributed version control system, which means you can work locally, -then share or "push" your changes to a server. In this case, the server is GitLab. +then share or *push* your changes to a server. In this case, the server you push to is GitLab. GitLab uses the SSH protocol to securely communicate with Git. When you use SSH keys to authenticate to the GitLab remote server, @@ -376,7 +376,9 @@ Git user has default SSH configuration? ... no Remove the custom configuration as soon as you can. These customizations are **explicitly not supported** and may stop working at any time. -## Troubleshooting SSH connections +## Troubleshooting + +### Password prompt with `git clone` When you run `git clone`, you may be prompted for a password, like `git@gitlab.example.com's password:`. This indicates that something is wrong with your SSH setup. @@ -386,3 +388,13 @@ This indicates that something is wrong with your SSH setup. - Try to manually register your private SSH key by using `ssh-agent`. - Try to debug the connection by running `ssh -Tv git@example.com`. Replace `example.com` with your GitLab URL. + +### `Could not resolve hostname` error + +You may receive the following error when [verifying that you can connect](#verify-that-you-can-connect): + +```shell +ssh: Could not resolve hostname gitlab.example.com: nodename nor servname provided, or not known +``` + +If you receive this error, restart your terminal and try the command again. |