Skip to content

Enhanced setup instructions with illustrative screenshots for improved clarity. #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Enhanced setup instructions with illustrative screenshots for improved clarity. #164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f31e6ec
Enhanced setup instructions with illustrative screenshots for improve…
git-pixel22 Oct 1, 2023
a73a7e1
Merge pull request #1 from init6-rj/init6-rj-patch-1
git-pixel22 Oct 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 39 additions & 11 deletions github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,51 @@ But you can still use `check50` and `submit50`! You just need to log in a bit di
## SSH

1. Open a terminal window, if not open already, within [Visual Studio Code](/code/), [CS50 IDE](/ide/index), [CS50 Sandbox](/sandbox/), or [CS50 Lab](/lab/).
1. Execute `ssh-keygen`. When prompted to "save the key," just hit Enter, without typing anything.
1. You'll then be prompted for a "passphrase" (i.e., password). If you only use your GitHub account for CS50, no need to input a passphrase; just hit Enter. Otherwise, input a passphrase (that you won't forget!), then hit Enter, then input it again, then hit Enter again. For security's sake, you won't see what you type. You'll then see a "randomart image" that you can ignore.
1. Execute `cat ~/.ssh/id_rsa.pub`. You'll then see your "public key," multiple lines of seemingly random text. Highlight and copy all of those lines, starting with `ssh-rsa` to the end. **But don't highlight your terminal window's prompts (which contain `$`) before or after those lines.**
1. Visit [https://github.com/settings/keys](https://github.com/settings/keys), logging in with your GitHub username and password as usual. Don't use the passphrase you just created, if any.
1. Click **New SSH Key**.
1. Paste your public key into the text box under **Key**. Optionally input a title under **Title** (e.g., `CS50`).
1. Click **Add SSH Key**.
1. Execute `ssh -T git@ssh.github.com -p 443`.
1. Enter "yes" and press enter if you see the following prompt (the IP address might be different):

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/41125327-ecfe-4b49-b776-dc9ecbee3f83)


2. Execute `ssh-keygen`. When prompted to "save the key," just hit Enter, without typing anything.

3. You'll then be prompted for a "passphrase" (i.e., password). If you only use your GitHub account for CS50, no need to input a passphrase; just hit Enter. Otherwise, input a passphrase (that you won't forget!), then hit Enter, then input it again, then hit Enter again. For security's sake, you won't see what you type. You'll then see a "randomart image" that you can ignore.

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/f2878e7c-fa61-4dd1-a070-a96209c79517)


4. Execute `cat ~/.ssh/id_rsa.pub`. You'll then see your "public key," multiple lines of seemingly random text. Highlight and copy all of those lines, starting with `ssh-rsa` to the end. **But don't highlight your terminal window's prompts (which contain `$`) before or after those lines.**

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/b9ff868f-7bca-47cb-80fa-f674a1fa6fd9)


5. Visit [https://github.com/settings/keys](https://github.com/settings/keys), logging in with your GitHub username and password as usual. Don't use the passphrase you just created, if any.

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/f1a880b2-818f-4f71-ab70-62ee66c7d35c)


6. Click **New SSH Key**.

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/1efc9a59-251c-45e0-adb5-a0dc354f5d20)


7. Paste your public key into the text box under **Key**. Optionally input a title under **Title** (e.g., `CS50`).
8. Click **Add SSH Key**.

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/a6573592-c9fc-4915-988e-56670afd6d4d)


9. Execute `ssh -T git@ssh.github.com -p 443`.
10. Enter "yes" and press enter if you see the following prompt (the IP address might be different):
```
The authenticity of host '[ssh.github.com]:443 ([140.82.113.35]:443)' can't be established.
ED25519 key fingerprint is SHA256:7KMZvJiITZ+HbOyqjKJV2AeC5As3GSZES5abcd1NIe4.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])?
```
1. If you input a "passphrase" (i.e., password) earlier, enter the passphrase and press Enter when you see the following prompt `"Enter passphrase for key 'home/ubuntu/.ssh/id_rsa':"`
1. You should be greeted with `"Hi USERNAME! You've successfully authenticated, but GitHub does not provide shell access."` If you don't see that, review the above steps to verify you didn't skip something.
11. If you input a "passphrase" (i.e., password) earlier, enter the passphrase and press Enter when you see the following prompt `"Enter passphrase for key 'home/ubuntu/.ssh/id_rsa':"`
12. You should be greeted with `"Hi USERNAME! You've successfully authenticated, but GitHub does not provide shell access."` If you don't see that, review the above steps to verify you didn't skip something.

![image](https://github.com/init6-rj/cs50.readthedocs.io/assets/84857474/5ba967f4-5fe3-4276-bd43-4aa419b57f36)


You should now be able to use `check50` and `submit50` (and `git`) without GitHub username and password. But if you created a passphrase, you might still be prompted for that.

Expand Down