pantheon-systems / documentation

Pantheon Docs
https://docs.pantheon.io
Other
189 stars 648 forks source link

Generate and Add SSH Keys Doc Update #9138

Open janmartincalulo opened 1 month ago

janmartincalulo commented 1 month ago

Re: Generate and Add SSH Keys

Priority: High

Issue Description: Hard to follow and usually not working for our customers.

Suggested Resolution

This is for Windows users:

Recommend installing Git Bash into their Local Windows Device: https://git-scm.com/download/win Once done, follow the commands in Mac/Linux: https://docs.pantheon.io/ssh-keys#macoslinux

Install and run git bash and follow:

MacOS/Linux Open your terminal and enter the following command to generate a key:

ssh-keygen -t rsa Please do not edit the default location of ~/.ssh/id_rsa unless you have a reason to change it. If the command says the key already exists, you can overwrite it, or continue to the next step with your existing key.

Set a passphrase for better security.

We recommend using a passphrase, but it can conflict with some tools.

Copy the contents of ~/.ssh/id_rsa.pub to your clipboard after the files are created.

MacOS users can cat the file to the terminal and copy the output:

cat ~/.ssh/id_rsa.pub Run eval to start the SSH agent. The Agent pid output confirms that the agent started:

Example:

eval `ssh-agent`
Agent pid 86810

Run ssh-keygen -lf ~/.ssh/id_rsa.pub -E md5 to check if the hash you have in your Pantheon User Dashboard's SSH Keys matches.

You are now set.

github-actions[bot] commented 1 month ago

👋 @janmartincalulo Thanks for opening your first issue here! @pantheon-systems/docs-admins is excited to review this!

If you like this project, please ⭐star⭐ our repo.

rachelwhitton commented 8 hours ago

thanks for this issue @janmartincalulo! Is it possible to do this with Windows 10 – WSL 2 Ubuntu 20.0 ? The terminus doc lists Git Bash as unsupported so I'd like to avoid pointing folks to that if we can avoid it given incompatibility with Terminus