SSH (and PAT) In-Depth Supplemental Episode

[kekoziar]

It has been decided (see #778) that minimum SSH is in the regular lesson, and a slightly advanced (including commands that are usually included in most tutorials for cloud repositories) will be added as a supplemental episode.

Since many people in the community are interested in contributing to this, and it might take some time to implement, we will first pursue this effort in a separate branch and later merge this branch into the main gh-pages branch.

This special branch has been created and is called ssh-adv. We, therefore, ask anyone who is interested in contributing to this effort to submit Pull Requests against this ssh-adv branch.

How to contribute

Start by fetching and checking out the ssh-adv branch into your current repository

git fetch https://github.com/swcarpentry/git-novice.git ssh-adv
git checkout ssh-adv

Now, you can start working on it as usual:

git checkout -b my-changes
# ... make changes...
git add
git commit
git push <your-fork>

... and submit a PR! When you submit a pull request on changes to this supplemental SSH episode (15-supplemental-ssh.md), make sure to select ssh-adv branch of this repository as the base branch. Only changes to that episode will be committed to the ssh-adv branch!

That's it!

We hope to see your Pull Request soon!

[ostueker]

Hello Carpenter's,

I wrote up some additional content for this supplemental SSH lesson. Let me know what you think of this.

I'm also thinking of covering the following:

• Using the macOS Keychain to store the SSH key. The benefit for macOS users is that they don't need to start the ssh-agent every time but only need to add the key once with ssh-add -K ~/.ssh/id_ed25519. Then the key should be automatically unlocked whenever they login to their account or on first use during a session. (I'm not a mac-user myself but several of my colleagues are so I will make sure that the information is correct)
• On Windows, users can install the PuTTY SSH client (or WinSCP or MobaXterm that bundles this) and then convert the SSH-key to the PuTTY format and load it into the "Pageant" SSH agent. Finally they just need to set an environment variable to use the plink.exe instead of ssh. Then it works very well with Git-for-Windows, but not with WSL or WSL2.
• Linux users can just rely on the SSH-agent or Keychain for their desktop.

I hope to have enough time to write that up early next week.

[kekoziar]

There are many duplicative SSH/PAT issues opened, so I'm adding the discussion tag so folks can also discuss the best way to add the additional material. Please refer to previous discussions, as well.

[longr]

Hope I am commenting in the correct place (following on from a duplicate issue mered into this, which was then closed).

Would it not make sense to remove the reference to this supplementary episode in the main lessons until the episode is completed? - or at lease available without looking at the source? If I get time I will try and contribute to the lesson, but nothing more frustrating than a reference to something that does not appear to exist.

[kekoziar]

Hope I am commenting in the correct place (following on from a duplicate issue mered into this, which was then closed).

Would it not make sense to remove the reference to this supplementary episode in the main lessons until the episode is completed? - or at lease available without looking at the source? If I get time I will try and contribute to the lesson, but nothing more frustrating than a reference to something that does not appear to exist.

@longr yes. feel free to update the callout.

[kekoziar]

There's still one reference in a call-out which needs to be removed until the supplemental episode is added.