Proposed SSH config user in README does not work
Summary
Hi! I had to give support for my users, and I would like to report it so documentation could be fixed if it should. Maybe it shouldn't, that's why I did not (yet) provided a MR.
Steps to reproduce
- Go to
help/ssh/README.md
in a GitLab instance (here in gitlab.com) - Go to section "Non-default OpenSSH key file names or locations"
Expected behavior
The proposed ~/.ssh/config
snippet should mention the default git
"User" entry, the default value in the vast majority of installations, including gitlab.com.
Actual behavior
The snippet mentions a mygitlabusername
"User" entry, without mentioning that the default value in a GitLab instance is git
.
Possible fixes
I think it could be less prone to errors to mention the default "git" user, and to mention that it depends on the GitLab installation.
We could also detail that the user can be found in the SSH clone URL : "user@gitlab-server/group/project"