Engineering-Tech Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== How to add an SSH Key for GITLAB ======


===== GET/SET SSH KEY =====

You need an SSH key that resides on your workstation/notebook. You can use an already existing key or generate a new one. 

To check if you already have an SSH key you have to check the file:

LINUX/MACOSX <code>.ssh/id_rsa.pub </code> 
WINDOWS <code>%userprofile%\.ssh\id_rsa.pub</code>

If this file contains an SSH-RSA key (open the file with a text editor), proceed to [[https://wiki.inf.unibz.it/auth/howto/sshkeygitlab#configure_gitlab_online| Configure the SSH key on gitlab.inf.unibz.it]].

If this file is empty or does not exist, it means that the key was never generated so you have to generate it. 

To generate an SSH key via command line open a LINUX/MACOSX terminal or WINDOWS Git BASH and run the command:
<code>ssh-keygen -t rsa -C "your@email" -b 4096</code>


When you're asked to "Enter a file in which to save the key," select either the default location or a location you prefer and leave as name id_rsa (if this is your only RSA key) or setup a file name of your choice.[[https://docs.gitlab.com/ee/ssh/README.html|GitLab Official Documentation]]  

<note important>Windows Git Bash your rsa-key (~/.ssh/id_rsa) file MUST be called id_rsa.</note>

You can also use a key generator such as [[http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html|PuTTYgen]] instead of using the terminal. Please refer to the guidelines of the product on how to create the RSA key and the location of the file.  

===== CONFIGURE GITLAB ONLINE =====
Login to GitLab and go to your profile -> Settings -> SSH Keys.

{{:auth:howto:gitlab-profile-settings.png?200|}}

In the field Key copy all the contents of the file: id_rsa.pub (or the specific name of your RSA key)

Choose a name to identify the key (ex. YourComputerName)

Click Add Key. 

The key is listed in your SSH Keys. 

[[https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html|Official Gitlab Documentation]]
===== GITLAB CLIENT CONFIGURATION =====

==== GLOBAL GIT ACCOUNT ====
You have to configure your locally installed gitlab client to connect using the ssh key. 

Inside a terminal (Linux, MacOS)/Git BASH (Windows), type the following: 

<code>
git config --global user.name "Firstname Lastname"
git config --global user.email "your@email"
git config --list
</code>

The last command should show the data you entered and is your gitlab global configuration. 

This data is saved in the file ~/.gitconfig: 

<code txt>
[user]
        name = Lastname Firstname
        email = your@email
</code>

Try to checkout repo. Should you experience trouble check the contents of file: .ssh/config. You can manually insert: 
<code>
host gitlabhostname.unibz.it
</code>


        
==== LOCAL GIT ACCOUNT ====
You can also have different git accounts (with different RSA keys) for different hosts. You can keep a global user/email configuration and a local configuration for a specific repository. In the root of a repository, run:

<code txt>
git config user.name "Firstname Lastname"
git config user.email "your_other@email"
</code>