1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
---
layout: default
title: Set Up Git (OSX)
description: A quick guide to help you get started with Git
---
<span class="intro">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 setting both up, and explain a little about how everything works along the way. If you already have Git experience and just want the short version, read the <a href="http://help.github.com">technical walkthrough instead</a>.</span>
##<span>First:</span> Download and Install Git
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, <a href="http://progit.org/book/ch1-3.html" target="_blank">take a crash course.</a>_
1. <span class="step-title">Download and install <a href="http://git-scm.com/" target="_blank">the latest version of Git</a>.</span>
__*Note*__ Don’t worry that you don’t see an icon when it’s done. It’s not that kind of application.
##<span>Next:</span> Set Up SSH Keys
We use SSH keys to establish a secure connection between your computer and GitHub. Setting them up is fairly easy, but does involves 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 Terminal.app, usually found at /Applications/Utilities.
<img src="/images/bootcamp/bootcamp_1_mac_terminal.jpg" width="558" height="200" alt="Open the terminal" />
<p>
<span class="explain">Need a quick lesson on Terminal?
<span class="explain-it-shell"><span class="triangle"> </span><span class="explain-it">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 comes with your Mac called Terminal.app. A line that begins with the dollar sign ($) indicates a line of code you need to type. To enter it, type the text that follows the $, hitting the return key at the end of each line. If you see a line in an example that doesn’t begin with a $ (we’ve made them <span class="terminal-output">green</span> in the bootcamp tutorials), that means it is a line of text that terminal has output for you to read and/or act upon. In the bootcamp examples, you can roll over the lines of Bash script for an explanation of what they do.<br/><br/>
<strong>Good to know</strong>: There will be times when you type code, hit return, and all you are given is another prompt. Some actions that you execute in the Terminal don’t have any output. Don’t worry, if there is ever a problem with your code, Terminal will let you know.<br/><br/>
<strong>Good to know</strong>: For security reasons, Terminal will not display what you type when entering passwords. Just type your password and hit the return key.
</span></span>
</span>
</p>
1. <span class="step-title">Check for SSH keys. <span>Have an existing kepair? You can skip to Step 4.</span></span>
First, we need to check for existing ssh keys on your computer:
<pre class="terminal bootcamp">
<span class="codeline">$ cd ~/.ssh<span class="terminal-tooltip">Checks to see if there is a folder named ".ssh" in you user directory</span></span>
</pre>
<p class="short-bottom-marg">Does it say "No such file or directory"?</p>
<p class="next-step"><strong>No:</strong> Go to Step 2<br /><strong>Yes:</strong> Skip to Step 3
</p>
2. <span class="step-title">Backup and remove existing SSH keys.</span>
Since there is already an SSH directory you’ll want to back it up and remove it:
<pre class="terminal bootcamp">
<span class="codeline">$ ls<span class="terminal-tooltip">Lists all the subdirectories in the current directory</span></span>
<span class="terminal-output codeline">config id_rsa id_rsa.pub known_hosts</span>
<span class="codeline">$ mkdir key_backup<span class="terminal-tooltip">Makes a folder called "key_backup" in the current directory</span></span>
<span class="codeline">$ cp id_rsa* key_backup<span class="terminal-tooltip">Copies the contents of the id_rsa folder into key_backup folder</span></span>
<span class="codeline">$ rm id_rsa*<span class="terminal-tooltip">Deletes the contents of the id_rsa folder</span></span>
</pre>
3. <span class="step-title">Generate a new SSH key.</span>
To generate a new SSH key, enter the code below. When asked to enter a file in which to save the key, just press enter without typing anything.
<pre class="terminal bootcamp">
<span class="codeline">$ ssh-keygen -t rsa -C "octocat@github.com"<span class="terminal-tooltip">Creates a new ssh key using the provided email</span></span>
<span class="terminal-output codeline">Generating public/private rsa key pair.</span>
<span class="terminal-output codeline">Enter file in which to save the key (/Users/octocat/.ssh/id_rsa):</span>
<span class="terminal-output codeline">Enter passphrase (empty for no passphrase):</span>
<span class="terminal-output codeline">Enter same passphrase again:</span>
</pre>
Which should give you something like this:
<pre class="terminal bootcamp">
<span class="terminal-output codeline">Your identification has been saved in /Users/octocat/.ssh/id_rsa.</span>
<span class="terminal-output codeline">Your public key has been saved in /Users/octocat/.ssh/id_rsa.pub.</span>
<span class="terminal-output codeline">The key fingerprint is:</span>
<span class="terminal-output codeline">01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db octocat@github.com</span>
<span class="terminal-output codeline">The key's randomart image is:</span>
<span class="terminal-output codeline">+--[ RSA 2048]----+</span>
<span class="terminal-output codeline">| .+ + |</span>
<span class="terminal-output codeline">| = o O . |</span>
<span class="terminal-output codeline">| = * * |</span>
<span class="terminal-output codeline">| o = + |</span>
<span class="terminal-output codeline">| o S . |</span>
<span class="terminal-output codeline">| o o = |</span>
<span class="terminal-output codeline">| o . E |</span>
<span class="terminal-output codeline">| |</span>
<span class="terminal-output codeline">| |</span>
<span class="terminal-output codeline">+-----------------+</span>
</pre>
4. <span class="step-title">Add your SSH key to GitHub.</span>
On the GitHub site _Click “Account Settings”_ > _Click “SSH Public Keys”_ > _Click “Add another public key”_
It’s important you copy your SSH key exactly as it is written without adding any newlines or whitespace. To ensure this, run the following code to copy the key to your clipboard.
<pre class="terminal bootcamp">
<span class="codeline">$ cat ~/.ssh/id_rsa.pub | pbcopy<span class="terminal-tooltip">Copies the contents of the id_rsa.pub file to your clipboard</span></span>
</pre>
Now paste it into the “Key” field
<img src="/images/bootcamp/bootcamp_1_ssh.jpg" width="558" height="373" alt="Paste your SSH Key" />
Hit “Add Key”
5. <span class="step-title">Test everything out.</span>
To make sure everything is working you'll now SSH to GitHub:
<pre class="terminal bootcamp">
<span class="codeline">$ ssh git@github.com<span class="terminal-tooltip">Attempts to ssh to github</span></span>
</pre>
Which should give you this:
<pre class="terminal bootcamp">
<span class="terminal-output codeline">The authenticity of host 'github.com (207.97.227.239)' can't be established.</span>
<span class="terminal-output codeline">RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.</span>
<span class="terminal-output codeline">Are you sure you want to continue connecting (yes/no)?</span>
</pre>
Don’t worry, this is supposed to happen. Type “yes”.
<pre class="terminal bootcamp">
<span class="terminal-output codeline">Warning: Permanently added 'github.com,207.97.227.239' (RSA) to the list of known hosts.</span>
<span class="terminal-output codeline">ERROR: Hi octocat! You've successfully authenticated, but GitHub does not provide <br />shell access</span>
<span class="terminal-output codeline">Connection to github.com closed.</span>
</pre>
##<span>Then: </span> Set Up Your Info
Now that you have Git set up and your SSH keys entered in GitHub, it’s time to configure your personal info.
1. <span class="step-title">Set your username and email.</span>
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.
<pre class="terminal bootcamp">
<span class="codeline">$ git config --global user.name "The Octocat"<span class="terminal-tooltip">Sets the name of the user for all git instances on the system</span></span>
<span class="codeline">$ git config --global user.email "octocat@github.com"<span class="terminal-tooltip">Sets the email of the user for all git instances on the system</span></span>
</pre>
2. <span class="step-title">Set your GitHub token.</span>
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”_
<img src="/images/bootcamp/bootcamp_1_token.jpg" width="558" height="245" alt="Copy your API token" />
In Terminal, run the following code, using your GitHub username and token in place of the ones shown.
<pre class="terminal bootcamp">
<span class="codeline">$ git config --global github.user octocat<span class="terminal-tooltip">Sets the GitHub username for all git instances on the system</span></span>
<span class="codeline">$ git config --global github.token 0123456789abcdef0123456789abcdef<span class="terminal-tooltip">Sets the GitHub token for all git instances on the system</span></span>
</pre>
__*Note*__ If you ever change your GitHub password, a new token will be created and will need to be updated.
##<span>Lastly:</span> Celebrate
Congratulations, you now have Git and GitHub all set up! What do you want to do next?
<ol class="next-steps">
<li>Set Up Git</li>
<li><a href="/create-a-repo/">Create A Repository</a></li>
<li><a href="/fork-a-repo/">Fork A Repository</a></li>
<li><a href="/be-social/">Be Social</a></li>
</ol>
|
