docs icon indicating copy to clipboard operation
docs copied to clipboard

Provide detailed instructions on how to check for `ssh-agent` on Windows with OpenSSH

Open mavaddat opened this issue 3 years ago • 24 comments

Code of Conduct

What article on docs.github.com is affected?

Description Link
Source article https://docs.github.com/en/authentication/troubleshooting-ssh/error-permission-denied-publickey
Nearest ancestral anchor point …#make-sure-you-have-a-key-that-is-being-used
Specific part …If you are using Git Bash, turn on ssh-agent:…
Screenshot of entire page using Edge Web Capture

screenshot of the current page contents with red-dashed outline around incomplete instructions

What changes are you suggesting?

When OpenSSH is installed using the Settings (Window 10 build 1809 and later; or Windows Server 2019), the ssh-agent runs as a background system service rather than returning a stringified batch script that needs to be eval'd.

See also 2019 update to top answer on "How to run ssh-add on windows?"

This means that the status quo instructions promoting either eval $(ssh-agent -s) or eval "$(ssh-agent -s)" will not work for some users, but will also not provide useful output. For me, either above command does nothing in PowerShell or cmd.

Additional information

A succinct emendation is to recommend Get-Service -Name ssh-agent | Get-Process in a PowerShell host to find the ssh-agent process ID.

A more detailed suggestion is to walk the reader through scrupulously determining what is providing ssh-agent, if anything.


edited by maintainer.

Content Plan

Here is the writer's review for this issue.

mavaddat avatar Oct 08 '21 19:10 mavaddat

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Oct 08 '21 19:10 welcome[bot]

@mavaddat Thanks so much for opening a PR! I'll get this triaged for review :zap:

ramyaparimi avatar Oct 08 '21 21:10 ramyaparimi

Tweaker tweaker 1 9erOn Oct 8, 2021 2:58 PM, "welcome[bot]" @.***> wrote: Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

—You are receiving this because you are subscribed to this thread.Reply to this email directly, view it on GitHub, or unsubscribe.

billybob3659 avatar Oct 11 '21 20:10 billybob3659

Hi @mavaddat, thanks for letting us know about this! We can't provide detailed instructions for every possible environment in this article, but we can rewrite the step so that it's clear that you need to start the ssh-agent and that this command will do so in most cases, but that you may need to consult the relevant documentation for your environment if not. You or anyone else is welcome to create a PR doing so!

lecoursen avatar Oct 27 '21 13:10 lecoursen

facebook.com/SamiChyBD

samichycombd avatar May 28 '22 15:05 samichycombd

facebook.com/SamiChyBD

samichycombd avatar May 28 '22 15:05 samichycombd

Hi! Im participating in Hacktoberfest and I'd like to know if this issue is counted in Hacktoberfest and if I can work on it?

Anika-Roy avatar Oct 11 '22 12:10 Anika-Roy

👋 @Anika-Roy - Feel free to work on any of our help wanted issues for Hacktoberfest! 🎃

cmwilson21 avatar Oct 11 '22 13:10 cmwilson21

[maintainer edit to remove spammy content]

admin-01-web avatar Nov 18 '22 09:11 admin-01-web

wave @Anika-Roy - Feel free to work on any of our help wanted issues for Hacktoberfest! jack_o_lantern

https://github.com/github/docs/issues/10967#comment-1319748668

admin-01-web avatar Nov 18 '22 09:11 admin-01-web

@mavaddat

admin-01-web avatar Nov 18 '22 09:11 admin-01-web

i want to work on this issues please assign me this issues

Antanukumar avatar Jan 23 '23 12:01 Antanukumar

👋 @Antanukumar - You or anyone else are welcome to submit a PR for this issue 👍

cmwilson21 avatar Jan 24 '23 02:01 cmwilson21

Let me work on this @mavaddat

ashutosh887 avatar Apr 27 '23 15:04 ashutosh887

@ashutosh887 You or anyone else are welcome to work on this ⚡

cmwilson21 avatar Apr 27 '23 19:04 cmwilson21

hi , please let me work on this as it my first go on docks @mavaddat

belindabithell avatar May 23 '23 09:05 belindabithell

@belindabithell You, or anyone else, are welcome to work on this issue ⚡

Please take a look at our help wanted section to find additional open issues you can work on.

cmwilson21 avatar May 23 '23 14:05 cmwilson21

Can you please do me a favor? As I am a beginner, I understand everything, but I am not able to distinguish what to do. Could you please explain to me what I need to do or provide me with any references that I can read and understand.

arjunsingh27 avatar Jun 25 '23 17:06 arjunsingh27

hi I am a beginner as well and i feel very lost . I am trying to teach myself but at times like today ...i am not sure where to start .I think we are in the same boat . please help me as well, if you can.

On Sun, Jun 25, 2023 at 6:07 PM ArjunSingh @.***> wrote:

Can you please do me a favor? As I am a beginner, I understand everything, but I am not able to distinguish what to do. Could you please explain to me what I need to do or provide me with any references that I can read and understand.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/10967#issuecomment-1606165020, or unsubscribe https://github.com/notifications/unsubscribe-auth/A7NNVGSU3VJ7H5UMCI63BSTXNBV53ANCNFSM5FUJZHDA . You are receiving this because you were mentioned.Message ID: @.***>

belindabithell avatar Jun 27 '23 16:06 belindabithell

@ashutosh887 You or anyone else are welcome to work on this ⚡

@cmwilson21 Is there a public channel to discuss with the team regarding my approach/any difficulty

ashutosh887 avatar Jun 27 '23 17:06 ashutosh887

@ashutosh887 You can seek help or discuss your efforts on the discussions forum: https://github.com/github/docs/discussions

Note that the purpose of GitHub Issues is to notify the developers of problems with their product or project. If you're seeking advice for how to implement a solution or learn how to accomplish a task, that's not typically what GitHub issues is intended to address. You may also try posting your question on a site like Stackoverflow, Quora or Reddit r/learnprogramming.

mavaddat avatar Jun 27 '23 19:06 mavaddat

I completely agree to you @mavaddat Will surely check them soon

ashutosh887 avatar Jun 27 '23 19:06 ashutosh887

👋 Hey @ashutosh887, @mavaddat is correct! You can also begin your PR, submit it (could also submit as a draft if you prefer), and ask any questions in your PR. A lot of questions get answered during the review process. 👍

cmwilson21 avatar Jun 30 '23 20:06 cmwilson21