GitLab Quick Start Guide

Info

This guide is tailored towards internal NHS England users with access to the internal instance of GitLab. If you do not have an existing account check your team's internal processes for onboarding new GitLab users. NHS England users should also see our Confluence guidance on our internal implementation of Gitlab, Github and Git.

If you have access to a different instance of GitLab then these steps should be mostly the same.

TLDR

Sign-in to GitLab.
Generate a Personal Access Token (PAT). Give it a name, expiry date, and a scope. Copy the PAT. More detailed steps here.
Use the PAT in place of a password when interacting with GitLab for the first-time. Learn more here.
Once all setup, you should be able to create a repository and clone it to your local machine.

Pre-requisites

Pre-requisite	Importance	Note
Introduction to Git	Necessary	It is important to get an understanding of Git before starting to use it
Git Quick Start Guide	Necessary	Git must be set up on your machine
GitLab Account	Necessary	This guide assumes that you have an account for GitLab

Generating a Personal Access Token (PAT)

Warning

Treat Personal Access Tokens like passwords.

Store them securely and do not share them.

If you are worried that a PAT might be compromised (or you haven't used one in a while) consider revoking it.

In the upper-right corner of any page on the GitLab website, click your profile picture, then click Preferences

Profile menu with the Preferences option highlighted

On the left sidebar, click Access Tokens

User Settings sidebar menu with the Access Tokens option highlighted

This will bring up the Personal Access Tokens page with the 'Add a personal access token' form at the top. Give your token a descriptive name under Token name, e.g. "Git Desktop Token".
To give your token an expiration, select a date in Expiration date field, using the calendar picker, or clear the field so the token will never expire.

tokens without expiration dates

It can be tempting to make tokens without expiration for convenience, but when you have a lot of them, its easy to leave old unused tokens laying around, potentially acting as security holes into our systems.

It's usually more secure to set an expiry date (e.g. 6 months) so any old tokens become useless after a period.

Select a scope for the token. For this guide, only the read_repository and write_repository scopes will be selected, but other scopes are available if you intend to do other things with the PAT.

PAT Token Scope

It is advised to give a PAT only the scope required for its use.

At the bottom of the form, under the scopes, click the blue Create personal access token.

GitLab token creation page with suggested values from previous steps filed out

Copy your new PAT and store it in a secure location for later use. You won't be able to see it again.

The generated token. This token has been hidden and since been revoked.

Using your PAT on your local Git installation

When you go to clone or otherwise access a GitLab repository, you will be prompted for your username and password. You can use your PAT instead of your password. In the command line:

$ git clone <repository's clone url>
Username: YOUR_USERNAME
Password: YOUR_TOKEN

When you go to access a Git repository in the future, you should not be prompted for your username and password as your credentials will be cached on your computer. Read this guide on caching credentials from GitHub for more details.

Troubleshooting credentials

You might see something like this at any point:

remote: HTTP Basic: Access denied
remote: You must use a personal access with 'read_repository' or 'write_repository' scope for Git over HTTP.
remote: You can generate one at https:// etc etc...
remote: Authentication failed for 'repository address you're attempting to git clone'

This can mean a number of things: either your access token has expired or you have entered the wrong access token for your password (or username even). If your access token has expired or is about to expire, you can check by going to GitLab Profile > Preferences > Access Tokens then scroll all the way down and see if there’s an Active Access Token and check the expiration date.

To fix this we need to create a new access token.

If you have an existing repositoryIf you don't have an existing repository

Next, in the command terminal type git pull -v (v stands for verification). This should prompt a new git credentials window.

In the terminal type git clone <url> but with the new credentials included in the URL, so:

git clone https://<username>:<NEW_ACCESS_TOKEN>@<domain>/example.git

Try it out

In this section, we will run through the steps of cloning a repository on GitLab to your local machine using Git.

Try It Out

Log into GitLab
Navigate to the repository you want to clone. Select the blue Clone menu to the right and copy the HTTPs URL shown.
To clone the new repository onto your local machine, open Git Bash. In a suitable directory, here the $HOME (C:/Users/$USER) directory is used, run the git clone command with the copied repository URL.
```
git clone <gitlab clone url>
```
If you have already configured your Git installation with a Personal Access Token (PAT) then this should run. However, if it prompts you for your username and password, complete the above sections on generating a PAT and using a PAT.
You can move into this repository with the cd, change directories, command.
```
cd <repository directory>
```
Now in this repository, we can examine the currently set remotes for the repository, which will be the address of our repository that we created on GitLab.
```
git remote -v
```
Finally, we can inspect the repository in Windows File Explorer.

Note

Due some settings and extensions used, there might be some small differences in what you see when viewing the repository in Windows File Explorer.

In the picture above, hidden files have been made visible through a setting change, and an extension to Windows Explorer is being used to render the README markdown for the preview.

Next Steps

Now that you have set up your GitLab account to communicate with your local Git installation, you might also want to set up your access to GitHub, if you have haven't already.

Alternatively, you can start learning about how to use git to collaborate with others; learning about branches, pull and merge requests, and how to deal with conflicting changes.

Finally, you might want to start practising using Git with our Committing Work Walkthrough walkthrough guide.

Last update: November 11, 2024

External Links Disclaimer

NHS England makes every effort to ensure that external links are accurate, up to date and relevant, however we cannot take responsibility for pages maintained by external providers.

NHS England is not affiliated with any of the websites or companies in the links to external websites.

If you come across any external links that do not work, we would be grateful if you could report them by raising an issue on our RAP Community of Practice GitHub.