Skip to content
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.

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

add more detail to README #254

Merged
merged 1 commit into from Mar 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 31 additions & 13 deletions README.md
Expand Up @@ -30,18 +30,18 @@ Follow the [Github Documentation](https://docs.github.com/en/authentication/conn
1.) Edit your local `~/.ssh/config` file to look like:

```
## Uncomment these so you can SSH to boxes without the full .stanford.edu domain name
## e.g., type `ssh sdr-infra` and the SSH client will use `*.stanford.edu` config
# CanonicalizeHostname yes
# CanonicalDomains stanford.edu

Host *.stanford.edu
# Forward your SSH key so you can interact with GitHub
ForwardAgent yes
# Set up Kerberos authentication
GSSAPIAuthentication yes
GSSAPIDelegateCredentials yes
# Specify your Stanford username here
## Uncomment these so you can SSH to boxes without the full .stanford.edu domain name
## e.g., type `ssh sdr-infra` and the SSH client will use `*.stanford.edu` config
# CanonicalizeHostname yes
# CanonicalDomains stanford.edu

Host *.stanford.edu
# Forward your SSH key so you can interact with GitHub
ForwardAgent yes
# Set up Kerberos authentication
GSSAPIAuthentication yes
GSSAPIDelegateCredentials yes
# Specify your Stanford username here
User <SUNETID without @stanford.edu>
Copy link
Member Author

Choose a reason for hiding this comment

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

whitespace changes only made by VS Code

```

Expand All @@ -51,13 +51,23 @@ Note that order matters in `config` so place this before (or comment out) `Host

```
# Or whatever the path is to the private key you've added to GitHub
ssh-add ~/.ssh/id_ed25519`
ssh-add ~/.ssh/id_ed25519
```
Copy link
Member Author

Choose a reason for hiding this comment

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

remove extra tick


3.) Verify the correct key(s) are forwarded to sdr-infra

Verify the results of `ssh-add -L` on both your laptop and `sdr-infra` match.

You can also try this on both your laptop and the server and verify you get the response shown. If not, then your local SSH key or forwarding may not be setup correctly.

See https://docs.github.com/en/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding for more information

```
ssh -T git@github.com

Hi [GITHUB_USERNAME]! You've successfully authenticated, but GitHub does not provide shell access.
```

### Connecting to sdr-infra.stanford.edu

With the above configuration, you will need to connect to `sdr-infra.stanford.edu` via ssh and will be presented with a MFA challenge:
Expand Down Expand Up @@ -89,6 +99,14 @@ Setup contribsys gem authentication (Sidekiq pro):
bundle config gems.contribsys.com USER:PASS
```

If already setup on your laptop, you can get the value for USER:PASS needed above:

```
# on your laptop, it should show the USER:PASS values
echo $BUNDLE_GEMS__CONTRIBSYS__COM
user123:pass678
```

### Check your SSH connection to all servers

```
Expand Down