Skip to content
Snippets Groups Projects
Commit 749e976b authored by Chi Pak's avatar Chi Pak
Browse files

Update README.md

parent 28aeb694
No related merge requests found
...@@ -25,22 +25,22 @@ Add SSH Key to Github Profile ...@@ -25,22 +25,22 @@ Add SSH Key to Github Profile
In order to download Github repos from the dorsolab group, In order to download Github repos from the dorsolab group,
you must provide authentication in the form of a `SSH key`. you must provide authentication in the form of a `SSH key`.
The SSH key, which acts like a permanent password, is added to your Git profile. The `SSH key`, which acts like a permanent password, is added to your Git profile.
#### Generate and Copy SSH Key #### Generate and Copy SSH Key
Once logged into BioHPC, Generate a SSH key by typing (or copy-and-paste) Once logged into BioHPC, Generate a `SSH key` by typing (or copy-and-paste)
``` ```
ssh-keygen -t rsa -C "your.email@example.com" -b 4096 ssh-keygen -t rsa -C "your.email@example.com" -b 4096
``` ```
where `your.email@example.com` should be replaced with your UTSW email. where `your.email@example.com` should be replaced with your UTSW email.
Then Press `Enter` when it asks for the default directory. Then Press `Enter` when it asks for the default directory.
Then Press `Enter` at both passphrase prompts (do not set a password). Then Press `Enter` at both passphrase prompts (do not set a password).
You will need to copy the SSH key generated above. You will need to copy the `SSH key` generated above.
To view your SSH key, type To view your `SSH key`, type
``` ```
cat ~/.ssh/id_rsa.pub cat ~/.ssh/id_rsa.pub
...@@ -52,23 +52,34 @@ You should see the following ...@@ -52,23 +52,34 @@ You should see the following
ssh-rsa ....... = your.email@example.com ssh-rsa ....... = your.email@example.com
``` ```
where `.......` is a long alphanumeric key that spans multiple lines. where `.......` is a long alphanumeric key that spans multiple lines. This is your SSH key.
Highlight the entire ssh key - starting from `ssh` and ending with `.com` and copy it.
Congrats, you've successfully copied your unique SSH key and are ready to add it to your Git profile. Highlight the entire `SSH key` - starting from `ssh` and ending with `.com` and copy it.
Then navigate to the `SSH Keys` tab in your `Profile Settings` and Congrats, you've successfully copied your unique `SSH key` and are ready to add it to your Git profile.
paste your key in the `Key` section and give it a relevant `Title`.
Log into your Git profile on [UTSW's Github page](https://git.biohpc.swmed.edu/) - upper right corner. #### Add SSH Key to Git Profile
![Portal Homepage](/images/portal_biohpc.jpg)
Log into your Git profile on [UTSW's Github page](https://git.biohpc.swmed.edu/).
To login, use your Portal or BioHPC username/password (*not your UTSW credentials*). To login, use your Portal or BioHPC username/password (*not your UTSW credentials*).
![Portal Login](/images/portal_login.jpg) ![Git Homepage](/images/git_homepage.jpg)
Once logged in, go to your Settings (upper right corner)
![Git Settings](/images/git_settings.jpg)
On the left, you'll see `SSH Key` - click on it
![Git SSH](/images/git_ssh.jpg)
Paste the `SSH key` you generated and copied above into the window titled `Key`
![Git Add Key](/images/git_ssh_addkey.jpg)
Finally, click `Add Key`. Congrats, you're done add the `SSH key` to your Git profile.
#### Need more Instructions?
Didn't think the abbreviated instructions provided enough details? Didn't think the abbreviated instructions provided enough details?
Go to the [full instructions](https://git.biohpc.swmed.edu/help/ssh/README) to add SSH key to your Git profile. Go to the [full instructions](https://git.biohpc.swmed.edu/help/ssh/README) to add SSH key to your Git profile.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment