Set up your framework

Marie-Pierre Etienne

https://github.com/MarieEtienne/reproductibilite

2025-09-01

Setting up GitHub and SSH

1. Create a GitHub Account

  1. Go to https://github.com
  2. Click Sign up
  3. Choose a username, email, and password
  4. Verify your account by email
  5. (Optional) Install GitHub Desktop if you prefer a GUI

2. Install Git (Linux)

On most Linux distributions, Git is available from the package manager.

  • On Debian/Ubuntu:

Check if Git is available if not

sudo apt update
sudo apt install git

2. Install Git (macOS)

Check if Git is available if not

brew install git

Check installation with:

git --version

2. Install Git (Windows)

Windows users should install Git for Windows, which includes Git Bash.

  1. Download from https://git-scm.com/download/win
  2. Run the installer and keep the default options
  3. After installation, open Git Bash from the Start menu
  4. Verify installation:
git --version

3. Generate an SSH key (Linux & macOS)

Open a terminal and type:

# create a new ssh key RSA (2048 bits) with no passphrase
ssh-keygen -t rsa -b 2048 -C "your_email@example.com"

# press enter to accept default file location (~/.ssh/id_rsa)
# press enter to use am empty passphrase

3. Generate an SSH key (Windows, Git Bash)

  1. Open Git Bash
  2. Run:
# create a new ssh key RSA (2048 bits) with no passphrase
ssh-keygen -t rsa -b 2048 -C "your_email@example.com"

# press enter to accept default file location (~/.ssh/id_rsa)
# press enter to use am empty passphrase

  1. Keys are saved by default in:

    • C:\Users\<YourUser>\.ssh\id_rsa

4. Add the SSH key to GitHub

  1. Copy the public key:
cat ~/.ssh/id_rsa.pub

(or open id_rsa.pub in a text editor on Windows)

  1. Go to GitHub → Settings → SSH and GPG keys
  2. Click New SSH key
  3. Paste the key, give it a name (e.g. My laptop), save

5. Test the connection

Run:

ssh -T git@github.com

If successful, you’ll see:

Hi username! You've successfully authenticated, but GitHub does not provide shell access.

6. Configuration

The purpose of Git is to keep tracks of different versions of a project and their authors.

To do so, you need to be authenticated. Before using, specify your name

The first use after installation

git config --global user.email "your email"
git config --global user.name "your name"`
git config -l # check

✅ Setup complete

You are now ready to clone, push, and pull using SSH with your GitHub account!