AD GitHub Usage Guide

Initial Setup

This document provides a step-by-step guide to start using GitHub in the Fermi-AD organization.

1. Joining Fermi-AD

• Get added to Fermi-AD organization (TBD).

2. Secure your account

• Configure your GitHub account with two-factor authetication (2FA)
• Configure Single Sing-On (SSO):
  • Make sure your GitHub account is associated with your @fnal.gov email address.
  • Set Up your git cli with SAML SSO

3. Verify GitHub credentials and configurations.

1. Check credentials: Verify that that you have valid GitHub credentials including your username, SSO and 2FA.
2. Set your Git identity in your development environment :

git config --global user.name "Your Name"
git config --global user.email "your-email@fnal.gov"

4. Network configuration - optional:

• Applies when working from Controls network - Set up your ~/.ssh/config to securely connect through a bastion using SSH to interact with GitHub.

Host github.com
    ProxyJump <bastion-host>

To request access to the bastion systems, please consult your line manager and have them complete a access request form on your behalf.

5. Repository Setup

• Review our content guidelines to determine the appropriate settings and structure for your repository. The recommendations will help you make informed decisions regarding repository visibility, collaboration settings, data sensitivity, security features, licensing, compliance, and external contributions.

Troubleshooting

Here’s a common problem and solution for VSCode users on Windows when enabling SSO:

Issue:

remote: The `fermi-ad' organization has enabled or enforced SAML SSO. To access
remote: this repository, you must re-authorize the OAuth Application `Git Credential Manager`.
fatal: unable to access '<repo URL>': The requested URL returned error: 403

Solution: Follow the instructions provided in this Stack Overflow thread instructions.

This site is open source. Improve this page.