Using Git with GeoLab - GeoLab User Docs

Git is a version control system installed in all GeoLab environments. You can clone repositories from GitHub or any other platform directly into your GeoLab environment.

You are responsible for managing the repositories you clone. Per the Acceptable Use Policy, GeoLab administrators are not responsible for issues arising from repository management.

Learning Git¶

There are many, many resources for learning to use git. While GeoLab does have an integrated git dashboard on the sidebar, we recommend learning the git CLI (command line interface) so your learning is portable to any future compute environments you might find yourself in. Once you understand git on the command line, using any version of a git GUI is an easy transition.

Recommended resources:

Why Git? Illustrated
Happy Git — While targeted at R users, very little of this guide is R-specific; it’s an excellent resource for all git learners
Free Code Camp: Learn Git in Under 10 Minutes

Git in GeoLab¶

Once you’ve logged into GeoLab, you can use git from the command line in the terminal. There is also a visual git GUI extension available by clicking the git icon on the left sidebar.

Connecting Accounts¶

If you have a github or gitlab account and wish to sync projects to it from GeoLab, you will need to run a few configuration steps. Note, git account setup is not required to clone a public repository.

1. Tell git who you are¶

In the terminal, run the following commands:

git config --global user.name "Your Name"
git config --global user.email "your_email@example.com"

You’ll only need to do this once. Your configs will be stored to a file if you ever need to modify them.

2. Authenticate¶

An SSH key lets you authenticate with your remote repository securely and without entering your password each time. The steps to set up your SSH key are as follows:

Generate SSH Key
In the GeoLab terminal, run:
```
ssh-keygen -t ed25519 -C "your_email@example.com"
```
When prompted, press Enter to accept the default file location. The default location is in the /home/jovyan/ directory, which persists between GeoLab logins. You can optionally set a passphrase or leave it empty for no passphrase.
Copy your public key
Display your public key using the following command in the GeoLab terminal:
```
cat ~/.ssh/id_ed25519.pub
```
Copy the entire output to your clipboard.
Add the key to your Git account
For GitHub:
1. Go to Settings → SSH and GPG keys → New SSH Key
2. Type in a title for the key, paste your key and click Add SSH key.
For GitLab:
1. Go to Preferences → Access → SSH Keys → Add new key
2. Paste your key, type in the title, set an expiration date for the key (optional) and click Add key.
Test the connection
For GitHub:
```
ssh -T git@github.com
```
Expected output:
Hi your_username ! You’ve successfully authenticated, but GitHub does not provide shell access.
For GitLab:
```
ssh -T git@gitlab.com
```
Expected output:
Welcome to GitLab, @your_username!

Best Practices¶

Avoid nested repository cloning (cloning a repository inside another repository), and keep all your clones in a single directory — /home/jovyan/ is a good choice.