Merge SSH keygen changes (Step 2) and troubleshooting to Main Branch#538
Merge SSH keygen changes (Step 2) and troubleshooting to Main Branch#538MSherren wants to merge 9 commits into
Conversation
2 new screenshots to demonstrate the new key for ssh documentation
Updating RMACC registry instructions to reflect the same instructions as the SSH authentication setup for AMC
b-reyes
left a comment
b-reyes
left a comment
There was a problem hiding this comment.
@MSherren Thank you so much for putting this together! I have some changes that I would like you to make so that the content follows some of the guidelines we have established in our documentation. Also, I suggested a small modification to your troubleshooting addition. If you have any questions on these changes, please let me know.
| ## *Step 2: Generate an ssh key* | ||
|
|
||
| You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. | ||
| You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. You are also strongly encouraged to create an ed25519 key type. |
There was a problem hiding this comment.
| You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. You are also strongly encouraged to create an ed25519 key type. | |
| You are strongly encouraged to set a passphrase for your key pair and generate a ed25519 key. You will be prompted to enter the passphrase each time you log in. |
|
|
||
| SSH Key Generation for Windows Users: | ||
| - Using the command prompt, PowerShell, or Windows Terminal: <https://www.howtogeek.com/762863/how-to-generate-ssh-keys-in-windows-10-and-windows-11/> | ||
| ### SSH Key Generation for Windows Users: |
There was a problem hiding this comment.
Instead of using headings for the Windows/Mac/Linux portions, please use tabs.
For documentation on how to create tabs, please see the bullet/dropdown in CURC documentation guidelines.
An example of this type of tab usage can be seen in Terminal access for different operating systems
| ``` | ||
| - After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: | ||
|
|
||
|  |
There was a problem hiding this comment.
When possible, we try to avoid pictures for terminal output. Instead, we place the content in a bash code block. This makes it easier to manipulate and gives us the freedom to change the things like the username very easily and modify it, if needed. Please replace these terminal output pictures with a bash code block.
| <br> | ||
| - |
There was a problem hiding this comment.
I think these can be removed.
| ``` | ||
| - After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: | ||
|
|
||
|  |
There was a problem hiding this comment.
Please see my note above. Please replace this terminal output picture with a bash code block.
|
|
||
|  | ||
| <br> | ||
| - NOTE for Mac users: There is a chance you need to create or alter your ssh config file (~/.ssh/config). See more in the [Troubleshooting](#troubleshooting) section below. |
There was a problem hiding this comment.
Please highlight all code or files with "code" highlighting i.e. the single back ticks.
| ``` | ||
| Host * | ||
| HostKeyAlgorithms ssh-ed25519 | ||
| PubkeyAcceptedAlgorithms ssh-ed25519 | ||
| ``` |
There was a problem hiding this comment.
Please indent this code block. It might also be better to specify the particular host, just incase they are connecting to other systems that do not require this.
You will have to test it out, but I think doing something like the following will make it so that it will only apply this if they login to our system:
Host login.rc.colorado.edu
HostKeyAlgorithms ssh-ed25519
PubkeyAcceptedAlgorithms ssh-ed25519
2 participants
After discovering the instructions for ssh keygen (step 2) were slightly out of date, generating an rsa key, I have updated the documentation to generate a newer ssh key. Additionally, I have added a troubleshooting step for the issue certain Mac's have run into.