Getting pueoBuilder

Table of Contents

• Step 1: set up secure shell
  • generate a key-pair
  • edit the configuration file
  • give GitHub the PUBLIC key
  • confirmation
• Step 2: clone the repo

Step 1: set up secure shell

• The following secure shell (SSH) setup tutorial is based on this video.
• Skip this step if you can already clone our repositories.

generate a key-pair

1. Go to the .ssh folder in your home directory (create one if it does not exist):

   cd ~/.ssh

2. Type the following in your terminal:

   ssh-keygen -t ed25519 -f id_github -C your-email@example.com

3. Press Enter twice if you want to skip making a passphrase.
4. The -t ed25519 option indicates that we will use this particular type of encryption for the key-pair.
5. The command creates two files: a private key id_github and a public key id_github.pub

edit the configuration file

1. Edit/create the ssh configuration file using any text editor. For instance,

   vim ~/.ssh/config

2. Put the following in the configuration file:

   Host GitHub_or_whatever_alias_you_want
     HostName github.com
     User git
     IdentityFile ~/.ssh/id_github
     AddKeysToAgent yes

   (quit vim by pressing Esc, then : (colon), then type wq to write and quit, hit Enter).

give GitHub the PUBLIC key

1. Go to the GitHub SSH and GPG keys setting page
2. Click on the green "New SSH key" button on the top right corner.
3. Enter whatever you want as the Title, for example OSC Cardinal.
4. Leave the Key type as "Authentication Key".
5. Go back to the terminal and type

   cat ~/.ssh/id_github.pub

   to print out the public key.
6. Copy whatever cat returns on your terminal to the field Key on GitHub

   Attention

   It is important that you are copying the public key!

7. click the green "Add SSH key" button.

confirmation

1. start the ssh agent with

   eval "$(ssh-agent -s)"

   You should see something like Agent pid 6563.
2. Check that the key works through

   ssh -T GitHub_or_whatever_alias_you_want

   (and enter yes if the computer asks you whether or not to continue connecting to github.com.)

   Note

   Additionally, you might want to put these two commands in your .bashrc or equivalent.
   This way, they are executed automatically next time you log in/start a new session.

3. If you see the following greeting message, it means you have suceeded:

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

Step 2: clone the repo

Run the following command to download pueoBuilder to, for example, your home directory:

git clone git@github.com:PUEOCollaboration/pueoBuilder.git ${HOME}/pueoBuilder