Other Pages

create_an_ssh_key.step

message "An SSH key uniquely identifies you (and your computer) when your computer is communicating with other computers. Think of an SSH key as a fancy password."
message "You'll need one of these to create your Heroku and Github accounts."
option "Did you use RailsInstaller on Windows?" do
message "Congratulations, you already have an ssh key!"
link_without_toc 'create_a_heroku_account'
end
option "Do you have a preexisting SSH key for some other reason?" do
message "Maybe you went to a previous RailsBridge workshop, or generated an SSH key to push some code to GitHub? You can check with the following command:"
console "ls ~/.ssh/id_rsa"
message "If you see the message **No such file or directory**, you don't have an SSH key yet."
option_half "'No such file or directory'" do
message "Go on to <a href='#generate-key'>Generate an SSH key"
end
option_half "'/Users/[something]/.ssh/id_rsa'" do
link_without_toc 'create_a_heroku_account'
end
end
a name: "generate-key"
option "Generate an SSH key" do
important "Use the same email address for heroku, git, github, and ssh."
important "**REPLACE** `student@example.com` with your **actual email address** below."
console "ssh-keygen -C student@example.com -t rsa"
message "Press enter to accept the default key save location."
message "Next, you'll be asked for a passphrase."
h1 "Choose whether to use a passphrase"
blockquote do
option_half "No passphrase" do
message "Hit enter to accept blank passphrase, then hit enter again."
end
option_half "Passphrase" do
message "If your computer is shared with other people, as in a work laptop, you should choose and enter a real passphrase. Twice."
end
end
message "After key generation is complete, you'll have output that looks like this."
result <<-OUTPUT
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/student/.ssh/id_rsa):
Created directory '/Users/student/.ssh'.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /Users/student/.ssh/id_rsa.
Your public key has been saved in /Users/student/.ssh/id_rsa.pub.
The key fingerprint is:
88:54:ab:77:fe:5c:c3:7s:14:37:28:8c:1d:ef:2a:8d student@example.com
OUTPUT
verify do
message "Your brand-new public key is now stored at `~/.ssh/id_rsa.pub`"
tip "Public vs. Private Keys" do
message "If you look inside `~/.ssh/`, you will notice two files with the same name: `id_rsa` and `id_rsa.pub`."
message "`id_rsa.pub` is your **public key** and can be shared freely."
message "`id_rsa` is your **private key** and must be kept secret."
message "If someone else gets your private key and your passphrase, then they can pretend to be you and log on to your Heroku or Github accounts and cause mischief!"
end
end
message "Add your generated key to the authentication agent using the following command:"
console "ssh-add ~/.ssh/id_rsa"
result <<-OUTPUT
Enter passphrase for /Users/student/.ssh/id_rsa:
Identity added: /Users/student/.ssh/id_rsa (/Users/student/.ssh/id_rsa)"
OUTPUT
tip "Could not open a connection to your authentication agent" do
message "If the ssh-agent is not running, you will come across this error. Here are a few commands that you can try to use to start the ssh-agent:"
console_with_message "For some Windows machines:", "eval `ssh-agent -s`"
console_with_message "For others (confirmed on some Windows 7, 8, 8.1, and 10 setups):", "eval $(ssh-agent)"
console_with_message "For Linux:", "eval `ssh-agent`"
message <<-MARKDOWN
<p>For additional options, this StackOverflow thread has been helpful: <a href=" http://stackoverflow.com/questions/17846529/could-not-open-a-connection-to-your-authentication-agent"> http://stackoverflow.com/questions/17846529/could-not-open-a-connection-to-your-authentication-agent</a></p>
MARKDOWN
end
end
next_step 'create_a_heroku_account'

Going through this curriculum on your own? Get help on our Discourse forum, where RailsBridge volunteers can answer your questions.

If you have a suggestion for improving the docs, please make a pull request or drop us a note via GitHub Issues (no technical knowledge required).