http://help.github.com/win-set-up-git/Set Up Git
If you’ve found yourself on this page, we’re assuming you’re brand new to Git and GitHub. This guide will walk you through the basics and explain a little bit about how everything works along the way.
At the heart of GitHub is an open source version control system (VCS) called Git*. Created by the same dudes that created Linux, Git is responsible for everything GitHub related that happens locally on your computer.
*If you don’t already know what Git is, take a crash course.
Download and install the latest version of Git for Windows.
Use the default options for each step.
Do not use PuTTY if you are given the option. GitHub only provides support for openssh.
We use SSH keys to establish a secure connection between your computer and GitHub. Setting them up is fairly easy, but does involve a number of steps.
To make sure you generate a brand new key, you need to check if one already exists. First, you need to open Git Bash (not the Windows command line), found in the start menu in the git.
Need a quick lesson about Git Bash?
Code blocks like those on this page are part of a scripting language called Bash. To use Bash scripts, we need to use an application that was installed with Git called Git Bash.
Input$ echo 'This is input text'This tooltip tells you what's going on.
A line that begins with the dollar sign ($) indicates a line of Bash script you need to type. To enter it, type the text that follows the $, hitting the return key at the end of each line. You can hover your mouse over each line for an explanation of what the script is doing.
OutputThis is output text.
A line that does not begin with a $ is output text that is intended to give you information or tell you what to do next. We’ve colored output text green in these bootcamp tutorials.
User Specific Input$ echo 'username'Outputs the text in the quotation marks.
Areas of yellow text represent your own personal info, repos, etc. If it is part of an input ($) line, you should replace it with your own info when you type it. If it is part of output text, it is just for your reference. It will automatically show your own info in Git Bash.
Good to know: There will be times when you type code, hit return, and all you are given is another prompt. Some actions that you execute in Git Bash don’t have any output. Don’t worry, if there is ever a problem with your code, Git Bash will let you know.
Good to know: For security reasons, Git Bash will not display what you type when entering passwords. Just type your password and hit the return key.
- Check for SSH keys. Have an existing key pair? You can skip to Step 4.
First, we need to check for existing ssh keys on your computer:$ cd ~/.sshChecks to see if there is a directory named ".ssh" in your user directory
If it says “No such file or directory“ skip to step 3. Otherwise continue to step 2.
- Backup and remove existing SSH keys.
Since there is already an SSH directory you’ll want to back the old one up and remove it:$ lsLists all the subdirectories in the current directory config id_rsa id_rsa.pub known_hosts $ mkdir key_backupmakes a subdirectory called "key_backup" in the current directory $ cp id_rsa* key_backupCopies the id_rsa and id_rsa.pub files into key_backup $ rm id_rsa*Deletes the id_rsa and id_rsa.pub files
- Generate a new SSH key.
To generate a new SSH key, enter the code below. We want the default settings so when asked to enter a file in which to save the key, just press enter.$ ssh-keygen -t rsa -C "firstname.lastname@example.org"Creates a new ssh key using the provided email Generating public/private rsa key pair. Enter file in which to save the key (/Users/your_user_directory/.ssh/id_rsa):<press enter>
Now you need to enter a passphrase.
Why do passphrases matter?
Passwords aren’t very secure, you already know this. If you use one that’s easy to remember, it’s easier to guess or brute-force (try many options until one works). If you use one that’s random it’s hard to remember, and thus you’re more inclined to write the password down. Both of these are Very Bad Things™. This is why you’re using ssh keys.
But using a key without a passphrase is basically the same as writing down that random password in a file on your computer. Anyone who gains access to your drive has gained access to every system you use that key with. This is also a Very Bad Thing™. The solution is obvious: add a passphrase.
But I don’t want to enter a long passphrase every time I use the key!
Neither do we! Thankfully, there’s a nifty little tool called
ssh-agentthat can save your passphrase securely so you don’t have to re-enter it. If you’re on OSX Leopard or later your keys can be saved in the system’s keychain to make your life even easier.
For more information about SSH key passphrases, check out our help guide.Enter passphrase (empty for no passphrase):<enter a passphrase> Enter same passphrase again:<enter passphrase again>
Which should give you something like this:Your identification has been saved in /Users/your_user_directory/.ssh/id_rsa. Your public key has been saved in /Users/your_user_directory/.ssh/id_rsa.pub. The key fingerprint is: 01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db email@example.com The key's randomart image is: +--[ RSA 2048]----+ | .+ + | | = o O . | | = * * | | o = + | | o S . | | o o = | | o . E | | | | | +-----------------+
- Add your SSH key to GitHub.
On the GitHub site Click “Account Settings” > Click “SSH Public Keys” > Click “Add another public key”
Open the id_rsa.pub file with a text editor (Notepad, TextEdit, or gedit will do just fine). This is your public SSH key. You may need turn on “view hidden files” to find it because the .ssh directory is hidden. It’s important you copy your SSH key exactly as it is written without adding any newlines or whitespace. Now paste it into the “Key” field.
Can’t view hidden files? Other ways to copy:
OSX$ pbcopy < ~/.ssh/id_rsa.pubCopies the contents of the id_rsa.pub file to your clipboard
You can open Git Gui, go to Help > Show Key, and then press Copy To Clipboard to copy your public key to your clipboard
Linux$ sudo apt-get install xclipDownloads and installs xclip $ xclip -sel clip < ~/.ssh/id_rsa.pubCopies the contents of the id_rsa.pub file to your clipboard
Now paste it into the “Key” field.
Hit “Add Key.”
- Test everything out.
To make sure everything is working you’ll now SSH to GitHub. Don’t change the “firstname.lastname@example.org” part. That’s supposed to be there.$ ssh -T email@example.comAttempts to ssh to github
Which should give you this:The authenticity of host 'github.com (22.214.171.124)' can't be established. RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48. Are you sure you want to continue connecting (yes/no)?
Don’t worry, this is supposed to happen. Type “yes”.Hi username! You've successfully authenticated, but GitHub does not provide shell access.
Setting up SSH can be problematic some times. Here are some frequent issues people run into:
SSH to GitHub
When it came time to run
$ ssh -T firstname.lastname@example.org you type your own email in there? If you did, you will need to run it again, making sure it says “email@example.com”. This is important because it is the address you are trying to SSH to (GitHub), not your email address.
Are you using
sudo? If you don’t know what that means, then you probably aren’t. If you are using it, stop! You shouldn’t use
sudounless you have a very good reason.
Agent admitted failure to sign using the key
This one only seems to happen to Linux users. To solve it, try this:$ ssh-add ~/.ssh/id_rsaAssociates your ssh key with ssh-agent
If that doesn’t solve it, check out this thread.
My connection was refused
You may be blocked by a firewall. First, you should check your ssh debug info:$ ssh -vT firstname.lastname@example.orgPrints debug info for the email@example.com SSH connection
Make sure it is connecting to GitHub on port 22. If it is, check to make sure your firewall is not blocking port 22.
When all else fails
Now that you have Git set up and your SSH keys entered into GitHub, it’s time to configure your personal info.
- Set your username and email.
Git tracks who makes each commit by checking the user’s name and email. In addition, we use this info to associate your commits with your GitHub account. To set these, enter the code below, replacing the name and email with your own. The name should be your actual name, not your GitHub username.$ git config --global user.name "Firstname Lastname"Sets the name of the user for all git instances on the system $ git config --global user.email "firstname.lastname@example.org"Sets the email of the user for all git instances on the system
More about user info
The steps listed above show you how to set your user info globally. This means that no matter which repo you work in on your computer, you’ll be making commits as that user. If you find yourself needing to make commits with different user info for a specific repo (perhaps for work vs. personal projects), you will have to change the info in that repo itself.$ cd my_other_repoChanges the working directory to the repo you need to switch info for $ git config user.name "Different Name"Sets the user's name for this specific repo $ git config user.email "email@example.com"Sets the user's email for this specific repo
Now your commits will be “blamed” on (associated with) new user name and email whenever working in the specified repo.
- Set your GitHub token.
Some tools connect to GitHub without SSH. To use these tools properly you need to find and configure your API Token.
On the GitHub site Click “Account Settings” > Click “Account Admin.”
At the command line run the following code, using your GitHub username and token in place of the ones shown.$ git config --global github.user usernameSets the GitHub username for all git instances on the system $ git config --global github.token 0123456789yourf0123456789tokenSets the GitHub token for all git instances on the system
*Note* If you ever change your GitHub password, a new token will be created and will need to be updated.
Congratulations, you now have Git and GitHub all set up! What do you want to do next?