Skip to content

docs: add SSH/GitHub authentication setup guide and helper script #94

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

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

docs: add SSH/GitHub authentication setup guide and helper script #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6d5f0b
Initial plan
Copilot Mar 7, 2026
83eb670
docs: add SSH/GitHub authentication setup guide and helper script
Copilot Mar 7, 2026
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
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,43 @@ Note:
- Baseline support runbook and command usage:
- `docs/ADMIN_SUPPORT_RUNBOOK.md`

## GitHub Authentication (SSH Setup)

This project uses SSH for Git operations.
Full guide: [`docs/SSH_GITHUB_SETUP.md`](docs/SSH_GITHUB_SETUP.md)

### Quick start

```bash
# 1. Generate a key (skip if you already have one)
ssh-keygen -t ed25519 -C "you@example.com"

# 2. Copy the public key and add it to github.com/settings/keys
cat ~/.ssh/id_ed25519.pub

# 3. Verify connection — the response shows which GitHub account is active
ssh -T git@github.com

# 4. Run the repo helper to diagnose any issues
bash scripts/check-ssh.sh
```

<!-- Screenshot placeholder: terminal output of `ssh -T git@github.com` showing "Hi <username>!" -->
<!-- ![SSH verification](assets/screenshots/ssh-verify-terminal.png) -->

### Troubleshooting at a glance

| Symptom | Fix |
|---|---|
| Settings → SSH keys page is **empty** | Make sure you are in your **personal** account settings, not an organization — go to `https://github.com/settings/keys` |
| Signed in as the wrong GitHub account | Sign out → sign in as the correct user → re-add the key |
| `Permission denied (publickey)` | Load the key: `ssh-add ~/.ssh/id_ed25519` |
| SAML/SSO error from organization | Visit `https://github.com/settings/keys` → Configure SSO → Authorize |
| Corporate firewall blocks SSH | Use the [PAT fallback](docs/SSH_GITHUB_SETUP.md#pat-fallback-https-authentication) |

See [`docs/SSH_GITHUB_SETUP.md`](docs/SSH_GITHUB_SETUP.md) for the full step-by-step
instructions, screenshot placeholders, and all troubleshooting scenarios.

## Troubleshooting

- `Executable doesn't exist` / Playwright browser missing:
Expand Down
Loading