Skip to content

Conversation

peterwwillis
Copy link
Contributor

I know the documentation here suggests you don't need a password, but I am suggesting this change for two reasons:

  1. If the user does want a password, they will want to use the -o option. Not using the -o option makes the password practically worthless. See here for details: https://latacora.singles/2018/08/03/the-default-openssh.html

  2. This documentation comes up on the top 10 Google search results for "how do I make an ssh key". It's likely that ssh users (even experienced ones) may use this guide to create new keys. It is important to get users into the habit of using the -o option, since it should be the default for the command anyway, but for whatever reason was never updated as such.

I know the documentation here suggests you don't need a password, but I am suggesting this change for two reasons:

1) If the user does want a password, they will want to use the -o option. Not using the -o option makes the password practically worthless. See here for details: https://latacora.singles/2018/08/03/the-default-openssh.html

2) This documentation comes up on the top 10 Google search results for "how do I make an ssh key". It's likely that ssh users (even experienced ones) may use this guide to create new keys. It is important we get users into the habit of using the -o option, since it should be the default for the command anyway, but for whatever reason was never updated as such.
----

First it confirms where you want to save the key (`.ssh/id_rsa`), and then it asks twice for a passphrase, which you can leave empty if you don't want to type a password when you use the key.
First it confirms where you want to save the key (`.ssh/id_rsa`), and then it asks twice for a passphrase, which you can leave empty if you don't want to type a password when you use the key. However, if you do use a password, make sure to add the `-o` option. You can also use the `ssh-agent` tool to prevent having to enter the password each time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this update, but I have one request. Can you reformat this so that each sentence is on its own line? It makes diffing much easier in the future (i.e. this will show up as two new lines, rather than a line deleted and two lines added).

@peterwwillis
Copy link
Contributor Author

Hi Ben, does this work?

First it confirms where you want to save the key (`.ssh/id_rsa`), and then it asks twice for a passphrase, which you can leave empty if you don't want to type a password when you use the key.

However, if you do use a password, make sure to add the `-o` option. You can also use the `ssh-agent` tool to prevent having to enter the password each time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you split up these sentences onto their own lines? Also, I don't think we need a paragraph break here, so go ahead and delete line 39.

@ben
Copy link
Member

ben commented Aug 6, 2018

✨ Thanks!

@ben ben merged commit cd5c748 into progit:master Aug 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants