Files
the_order/docs/GITHUB_SETUP.md
defiQUG 62815936cc docs: Add GitHub authentication setup guide and push script
- Add scripts/push-to-github.sh for automated push after SSH setup
- Add docs/GITHUB_SETUP.md with comprehensive setup instructions
- Includes SSH key setup, token-based authentication, and troubleshooting
2025-11-10 20:28:14 -08:00

101 lines
2.2 KiB
Markdown

# GitHub Authentication Setup
## Current Status
**Commit ready to push:** `2633de4 feat(eresidency): Complete eResidency service implementation`
**SSH key generated:** `~/.ssh/id_ed25519`
**Remote configured:** `git@github.com:Order-of-Hospitallers/the-order-monorepo.git`
⚠️ **Push blocked:** SSH key needs to be added to GitHub
## Your SSH Public Key
```
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGb+gFevwMFw/Li1JLyIvpYZ4O6/f1KHutekqtPapY/l defi@defi-oracle.io
```
## Quick Setup (SSH - Recommended)
1. **Copy your SSH public key:**
```bash
cat ~/.ssh/id_ed25519.pub
```
2. **Add to GitHub:**
- Visit: https://github.com/settings/keys
- Click "New SSH key"
- Title: `WSL2 - the-order-monorepo`
- Paste the public key
- Click "Add SSH key"
3. **Test connection:**
```bash
ssh -T git@github.com
```
You should see: `Hi defiQUG! You've successfully authenticated...`
4. **Push your commit:**
```bash
git push
```
Or use the script:
```bash
./scripts/push-to-github.sh
```
## Alternative: Personal Access Token (HTTPS)
If you prefer HTTPS:
1. **Create a Personal Access Token:**
- Visit: https://github.com/settings/tokens
- Click "Generate new token (classic)"
- Select `repo` scope
- Generate and copy the token
2. **Configure credential helper:**
```bash
git config --global credential.helper store
```
3. **Update remote URL:**
```bash
git remote set-url origin https://github.com/Order-of-Hospitallers/the-order-monorepo.git
```
4. **Push (enter token as password):**
```bash
git push
Username: defiQUG
Password: <paste-your-token-here>
```
## Verification
After pushing, verify with:
```bash
git log --oneline origin/main..HEAD
```
Should show no commits (all pushed).
## Troubleshooting
- **Permission denied:** Make sure SSH key is added to GitHub
- **Key not found:** Run `ssh-add ~/.ssh/id_ed25519`
- **Connection timeout:** Check your internet connection
- **Wrong key:** Verify key fingerprint matches GitHub
## Next Steps
Once pushed, your changes will be available on GitHub and can be:
- Reviewed in pull requests
- Deployed via CI/CD
- Collaborated on with team members