- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
You can install GitLab on several cloud providers,
or use one of the following methods.
Linux package
The Linux package includes the official deb and rpm packages. The package has GitLab and dependent components, including PostgreSQL, Redis, and Sidekiq.
Use if you want the most mature, scalable method. This version is also used on GitLab.com.
For more information, see:
- Linux package
- Reference architectures
- System requirements
- Supported Linux operating systems
Helm chart
Use a chart to install a cloud-native version of GitLab and its components on Kubernetes.
Use if your infrastructure is on Kubernetes and you’re familiar with how it works.
Before you use this installation method, consider that:
- Management, observability, and some other concepts are different than traditional deployments.
- Administration and troubleshooting requires Kubernetes knowledge.
- It can be more expensive for smaller installations.
- The default installation requires more resources than a single node Linux package deployment, because most services are deployed in a redundant fashion.
For more information, see Helm charts.
GitLab Operator
To install a cloud-native version of GitLab and its components in Kubernetes, use GitLab Operator.
This installation and management method follows the Kubernetes Operator pattern.
Use if your infrastructure is on Kubernetes or OpenShift, and you’re familiar with how Operators work.
This installation method provides additional functionality beyond the Helm chart installation method, including automation of the GitLab upgrade steps. The considerations for the Helm chart also apply here.
Consider the Helm chart installation method if you are limited by GitLab Operator known issues.
For more information, see GitLab Operator.
Docker
Installs the GitLab packages in a Docker container.
Use if you’re familiar with Docker.
For more information, see Docker.
Source
Installs GitLab and its components from scratch.
Use if none of the previous methods are available for your platform. Can use for unsupported systems like *BSD.
For more information, see Source.
GitLab Environment Toolkit (GET) is a set of opinionated Terraform and Ansible scripts.
Use to deploy a reference architecture on selected major cloud providers.
This installation methods has some limitations, and requires manual setup for production environments.
Unofficial and community-supported distributions
- Debian Native
- FreeBSD
- Arch Linux
- Puppet Module
- Ansible Playbook
- GitLab Virtual Appliance (KVM)
- GitLab on Cloudron
Unsupported Linux distributions and Unix-like operating systems
- Arch Linux
- Fedora
- FreeBSD
- Gentoo
- macOS
Installation of GitLab on these operating systems is possible, but not supported.
For more information, see:
- Installation guides
- Supported and unsupported OS versions for Linux package installations
Microsoft Windows
GitLab is developed for Linux-based operating systems.
It does not run on Microsoft Windows, and we have no plans to support it in the near future. For the latest development status, view this issue.
Consider using a virtual machine to run GitLab.
Last Updated :
16 Sep, 2024
GitLab is a popular DevOps platform that provides a robust solution for source code management, continuous integration/continuous deployment (CI/CD), and other development workflows. While GitLab is typically hosted on Linux servers, it can also be installed on Windows using a virtual machine or Docker.
In this article, we will walk you through the steps to install GitLab on Windows using Docker, which provides a manageable and efficient way to run GitLab without needing to configure a full Linux environment.
Prerequisites
Before installing GitLab on Windows, ensure you have the following prerequisites:
- Windows 10 Pro, Enterprise, or Education: Required for Docker Desktop.
- Docker Desktop: A platform that allows you to run Docker containers on Windows.
- Sufficient System Resources: At least 4 CPU cores and 4GB of RAM for GitLab to run smoothly. Higher specifications are recommended for production environments.
Installing Docker on Windows
To run GitLab on Windows, you’ll need to install Docker Desktop, which enables running containers on Windows systems.
Step 1: Download Docker Desktop
Go to the Docker Desktop website and download the installer for Windows.
Step 2: Install Docker Desktop
- Run the installer and follow the on-screen instructions.
- When prompted, enable the option for Windows Subsystem for Linux (WSL 2) for better performance.
Step 3: Start Docker Desktop
- Once installed, launch Docker Desktop and ensure it is running. You should see the Docker icon in the system tray.
Step 4: Verify Docker Installation
Open Command Prompt or PowerShell and type:
docker --version
You should see the version of Docker installed, confirming that Docker is set up correctly.
Downloading and Running GitLab Using Docker
With Docker installed, you can now download and run GitLab using Docker containers.
Step 1: Pull the GitLab Docker Image
Open PowerShell or Command Prompt and pull the GitLab image from Docker Hub:
docker pull gitlab/gitlab-ee:latest
This command pulls the latest version of GitLab Enterprise Edition. If you prefer the Community Edition, use gitlab/gitlab-ce:latest.
Step 2: Run GitLab in a Docker Container
Create a new directory on your Windows system to store GitLab configuration and data. This ensures data persists even if the container is removed:
mkdir C:\gitlab\data
mkdir C:\gitlab\logs
mkdir C:\gitlab\config
Step 3: Start the GitLab container:
docker run --detach `
--hostname gitlab.local `
--publish 443:443 --publish 80:80 --publish 22:22 `
--name gitlab `
--restart always `
--volume C:\gitlab\config:/etc/gitlab `
--volume C:\gitlab\logs:/var/log/gitlab `
--volume C:\gitlab\data:/var/opt/gitlab `
gitlab/gitlab-ee:latest
Options:
- —hostname: Sets the hostname for GitLab (e.g., gitlab.local).
- —publish: Maps ports from the container to the host (HTTP, HTTPS, and SSH).
- —name: Names the container gitlab.
- —restart always: Ensures GitLab restarts automatically if the container stops or the host reboots.
- —volume: Maps local directories to container directories for persistent storage.
Step 3: Wait for GitLab to Initialize:
It may take several minutes for GitLab to initialize. You can monitor the process using:
docker logs -f gitlab
Wait until you see the message indicating that GitLab is ready.
Configuring GitLab
After GitLab starts, you can configure it through the GitLab interface:
Step 1: Access GitLab
- Open a web browser and navigate to http://localhost.
- You should see the GitLab login screen.
Step 2: Set Up the Root Password
The first time you access GitLab, you’ll be prompted to set the root password. Enter a secure password and save it.
Step 3: Log In:
Log in using the username root and the password you just set.
Step 4: Configure GitLab Settings
Navigate to the Admin area to configure GitLab settings, such as email notifications, user management, and project settings.
Accessing GitLab
To access GitLab, simply navigate to the hostname you set during the Docker run command (e.g., http://localhost if using the default setup). If you mapped the ports differently or used a different hostname, adjust the URL accordingly.
Setting Up GitLab Runner (Optional)
GitLab Runner is a tool used for running CI/CD jobs on your GitLab instance. Installing GitLab Runner on Windows allows you to leverage GitLab’s powerful CI/CD pipelines.
Step 1: Download GitLab Runner
Visit the GitLab Runner downloads page and download the binary for Windows.
Step 2: Install GitLab Runner:
- Extract the binary to a directory, for example, C:\GitLab-Runner.
- Open Command Prompt as Administrator and register the runner:
C:\GitLab-Runner\gitlab-runner.exe register
- Follow the prompts to configure the runner with your GitLab instance, including:
- GitLab URL.
- Registration token (found in GitLab’s Admin area under Runners).
- Runner description, tags, and executor type (use shell for simplicity on Windows).
Step 3: Start the Runner
Install and start GitLab Runner as a service:
C:\GitLab-Runner\gitlab-runner.exe install
C:\GitLab-Runner\gitlab-runner.exe start
GitLab is a popular tool for managing Git repositories, allowing developers to work together on code, handle projects, and automate software testing and deployment. This article provides a step-by-step guide to installing GitLab on a Windows system, making it easy for developers to get started with this powerful platform.
Key Takeaways
- GitLab is a web-based tool for managing Git repositories and streamlining the development process.
- Before installing GitLab on Windows, ensure your computer meets the minimum system requirements and you have the necessary user permissions.
- The installation process includes downloading GitLab Runner, setting it up, and registering it with your GitLab account.
- Configuring GitLab Runner involves obtaining a registration token, setting up tags, and choosing executors.
- Verifying and running GitLab involves starting the GitLab Runner, checking the installation, and troubleshooting any issues.
Checking System Requirements
Before you dive into installing GitLab on your Windows machine, it’s crucial to ensure your system meets the necessary requirements. This will help GitLab run smoothly and efficiently.
Minimum Hardware Specifications
To get started, your system should at least have:
- Processor: 4 cores
- Memory: 4 GB RAM
- Disk Space: 25 GB
While these are the minimum requirements, having a more powerful system will provide a better experience.
Operating System Compatibility
GitLab is compatible with Windows 7 and later versions. Make sure your operating system is up-to-date to avoid any compatibility issues.
User Privileges Needed
You’ll need administrative privileges to install GitLab. This ensures you can make the necessary changes to your system during the installation process.
Important: Ensure you have a GitLab account ready for registration during the setup process.
Installing Prerequisite Software
Downloading Git for Windows
First, you need to download Git for Windows. Head over to the official Git website and grab the installer. Run the installer and follow the on-screen instructions. Make sure to select the default options unless you have specific needs.
Setting Up Docker for Windows
Next, you’ll need Docker. Visit the Docker website and download Docker Desktop for Windows. Run the installer and follow the prompts. After installation, open Docker Desktop and complete the initial setup. Ensure Docker is running before moving on.
Installing OpenSSH
Finally, you need OpenSSH. Open your PowerShell as an administrator and run the following command:
Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0
This will install the OpenSSH client on your system. To verify the installation, type ssh in your command prompt. If you see a list of SSH commands, you’re good to go.
Pro Tip: Always keep your software up to date to avoid security vulnerabilities.
Downloading and Setting Up GitLab Runner
Creating a Dedicated Folder
First, create a folder on your system to keep things organized. For example, you can create a folder named C:\GitLab-Runner. This will be the home for all your GitLab Runner files.
Downloading the GitLab Runner Binary
Next, download the GitLab Runner binary. You can find the latest version on the official GitLab website. Choose the appropriate version for your system, either 64-bit or 32-bit. Once downloaded, move the binary to the folder you created earlier.
Renaming and Organizing the Binary
After moving the binary, rename it to gitlab-runner.exe for simplicity. This makes it easier to run commands later. Ensure that the folder and the binary have restricted write permissions to prevent unauthorized changes. This step is crucial for maintaining security.
> **Pro Tip:** Keeping your binaries organized and properly named can save you a lot of headaches down the line.
Installing GitLab on Windows
Running the GitLab Installer
First, you need to run the GitLab installer. Download the installer from the official GitLab website. Once downloaded, open the installer and follow the on-screen instructions. Make sure to run the installer as an administrator to avoid any permission issues.
Choosing Installation Components
During the installation, you’ll be prompted to choose which components to install. Select the components that are necessary for your setup. Typically, you’ll want to install the GitLab Runner and any additional tools that you might need for your projects.
Selecting the Installation Directory
Next, you’ll need to choose the installation directory. By default, GitLab will suggest a directory, but you can change it if needed. Ensure that the directory has enough space to accommodate GitLab and its dependencies.
It’s crucial to select a directory with sufficient disk space to avoid running into issues later on.
Once you’ve completed these steps, GitLab will begin the installation process. This might take a few minutes, so be patient. After the installation is complete, you can proceed to configure GitLab Runner and start using GitLab on your Windows machine.
Configuring GitLab Runner
Registering the GitLab Runner
Before using the runner to execute jobs, it must be registered with GitLab. Open a command prompt and navigate to the directory where GitLab Runner is installed. Then, run the following command:
gitlab-runner.exe register
This command will prompt you to enter the URL of your GitLab instance and the registration token. After providing this information, you will be prompted to configure the runner. Follow the prompts to configure the runner as needed.
Obtaining a Registration Token
To get the token, log in to your GitLab account. Go to your project and click on the CI/CD option under the Settings tab. Expand the Runners Settings option. Under the Runners Settings section, you will get the token. Make sure to keep this token secure as it is essential for registering the runner.
Setting Up Tags and Executors
After entering the registration token, you will be asked to enter a description for the runner. Next, you will be prompted to enter tags for the runner. These tags help in identifying the runner and can be changed later in the GitLab user interface. You can lock the runner to the current project by setting it to true.
Finally, you will be asked to enter the executor for building the project. Executors can be of various types like shell, docker, or virtualbox. Choose the one that best fits your needs. Once done, you will see a message saying ‘Runner registered successfully’.
To the right of the runner, you want to edit, select edit ( ). In the maximum job timeout field, enter a value in seconds. The minimum amount is 600 seconds (10 minutes).
Verifying and Running GitLab
Starting GitLab Runner
To start the GitLab Runner, open PowerShell or Command Prompt and navigate to the directory where you installed it. Run the following commands:
cd C:\GitLab-Runner
.\GitLab-runner.exe start
This will start the GitLab Runner service. Make sure it runs without errors.
Checking the Installation
After starting the GitLab Runner, you need to verify that everything is set up correctly. Open your web browser and go to the URL where you installed GitLab. Log in with your admin credentials.
- Navigate to the Admin Area.
- Check the status of your GitLab instance.
- Ensure all services are running smoothly.
Troubleshooting Common Issues
If you encounter any issues, here are some common problems and their solutions:
- Runner not starting: Ensure you have the correct permissions and that no other service is using the same port.
- Cannot access GitLab URL: Double-check your DNS settings and make sure your firewall allows inbound HTTP/HTTPS traffic.
- Services not running: Restart the GitLab services using the command
sudo gitlab-ctl restart.
If problems persist, consult the GitLab documentation or seek help from the GitLab community.
By following these steps, you should have a fully functional GitLab instance running on your Windows machine. Enjoy your new setup!
Automating GitLab Runner as a Service
Automating GitLab Runner as a service ensures that the runner is always available to execute pipelines. This section will guide you through the process of setting up GitLab Runner as a service on Windows and managing it effectively.
Frequently Asked Questions
What are the minimum hardware requirements for installing GitLab on Windows?
You need a Windows machine with at least 4GB of RAM and 2 CPU cores. It’s recommended to have a more powerful system for better performance.
Can I install GitLab directly on Windows?
No, GitLab itself cannot be installed directly on Windows. However, you can use GitLab Runner on Windows to interact with a GitLab instance running on a Linux server.
Do I need administrative privileges to install GitLab Runner on Windows?
Yes, you need administrative privileges to install and configure GitLab Runner on a Windows machine.
What software do I need to install before setting up GitLab Runner on Windows?
You need to install Git for Windows, Docker for Windows, and OpenSSH before setting up GitLab Runner.
Where can I find the registration token for GitLab Runner?
You can find the registration token in your GitLab project under Settings > CI/CD > Runner settings.
How do I start GitLab Runner as a service on Windows?
You can set up GitLab Runner to run as a service by configuring it to start automatically and managing it through the Windows Services interface.
In the last article, we saw the various parts of GitLab, its architecture and how GitLab works. If you haven’t already, I suggest reading the previous article first before reading this one. Here is the link
GitLab, A Complete Beginner’s Guide!
In this article lets look at how to set it up locally on your Windows PC, so that you can have your very own GitLab setup running right at your home or organization!
If you are using Mac or Linux, you can follow the links below.
Complete Guide To Setting Up GitLab Locally On Mac.
Complete Guide To Setting Up GitLab Locally On Linux PC..!!
So let’s begin!
Things you will need
All you need are a computer running Windows OS with enough resources (CPU, memory, and disk space) for running the GitLab Server and GitLab Runner. How much resources is enough depends on how much performance you need, the more you have the better it is!
You can also set it up on the cloud over at Gitlab.com, but
- the free plans have some limitations in terms of processing power and hard disk space.
- Also doing it locally gives you more control over the setup and
- it will also be an opportunity to learn you more about GitLab
Hence I suggest taking this route of a local installation.
If you are part of a larger organization, and you wish to install it on the cloud, then you can always take a look at the paid plans of GitLab here link
Approach to install GitLab on Windows
Okay, let’s get back to the task in hand.
As we saw in the previous article GitLab consists of 2 parts.
- GitLab Server and
- GitLab Runner
Also, we have learned in the previous article that it is preferable to set the GitLab server and runners on separate computers. But I am going for a home set up, so I will be setting them both upon the same Windows computer.
The GitLab Server relies heavily on Linux technologies and hence it cannot be installed in our Windows PC natively. If you do some research, there are ways you can do it through the Linux subsystem in windows, but we are not going to take that approach.
The
problem with these workarounds are
- The installation process is a bit complicated and is not recommended for beginners.
- They are only guaranteed to work on a version to version basis. What I mean by that is you need to have a particular version of Windows and a particular version of GitLab for everything to run smoothly. If you update your Windows or if you wish to upgrade your GitLab then you might break your GtiLab set up. Since both Windows and GitLab updates come frequently, it is not such a good idea to waste time trying to fix things every few months.
- It is unofficial and hence support for future versions cannot be guaranteed.
- These unofficial methods will bring their own limitations as opposed to running natively on Linux
Due to these above reasons, we are going to go for a more stable approach of installing the GitLab server in a virtual environment. We will also see in this article the ways to make it run as smoothly and efficiently as possible while making sure it consumes as few resources as possible.
So this
is what we are going to do
- Install the GitLab Server on a Virtual Box running Ubuntu server
- Install GitLab runner natively on Windows.
This approach takes away the cons of using unofficial hacks, as it will work on all versions of you Windows and GitLab and you don’t need to worry too much while updating your software either!
By following the step by step guide shown below you should be able to set everything up and running in an hour or 2 (depending upon how good your internet connection is, it can take longer!)
GitLab Installation Process
STEP#1: Download and install VirtualBox
You can download and install VirtualBox from this link
Just click on the Windows hosts and the download should start automatically. The installation process is pretty straightforward, you can just accept the default options and click through to complete the process.
Once the installation is completed you can open VirtualBox from the Start menu in Windows.
STEP#2: Install Ubuntu Server as a Virtual Machine in your Windows PC.
The next step is to get a Linux distro to install our GitLab server. For this purpose, I recommend Ubuntu Server. I chose this particular distro for 2 reasons.
- Ubuntu is known for its stability.
- GitLab Server software has support for Ubuntu
- The server edition is chosen so that it will consume fewer resources on your computer.
For this first, you need the Ubuntu Server image. You can download it from this link.
Ubuntu usually offers 2 sets of packages for us to choose from.
- Long term support version: Has a support period of 5 years
- Latest Version: has all the latest features.
I suggest you go for the LTS one, but then the latest version should also work just fine. So click on a “Download” button and your download should start automatically. It will take some time to complete as the iso is around 900MB.
Once the download is complete you can proceed to the installation process on VirtualBox.
STEP#3: Install Ubuntu Server on VirtualBox
Open VirtualBox Application and click on the “New” button
A window like this should pop up
Give your virtual machine a name and choose Linux for type and ubuntu 64 bit for version and click “Continue”.
The next screen usually asks for RAM. GitLab recommends 8GB for a GitLab system with 100 users, I suggest a minimum of 2GB RAM for a home set up, you can give more if you can, just make sure you don’t allot more than 50% of your total available RAM.
Once you have allocated RAM space, Click “Continue” to the next page.
Next, you will be prompted for hard disk. Make sure “Create a virtual hard disk now” is selected and click “Create”
Accept
the default “VDI (VirtualBox Disk Image)” and click
“Continue”
Accept “Dynamically Allocated” and Press continue. This option allocates hard disk space to the virtual machine on the run, so that as you use the more space, more will be allocated.
I suggest you allocate at least 25GB of space to the virtual machine, you can allot more if you can. Once you have chosen the disk space click create
Once you have done this, you should be taken back to the main window of VirtualBox and you should see the virtual machine you just created on the left pane of the window as shown in the screenshot below.
Next click on the “Settings”
And click on storage -> empty -> disk icon -> “Choose a disk file”
Select the ubuntu server iso image you have just downloaded and press ok. This is equivalent to inserting the Ubuntu disk in a real machine.
Next, go to settings->Network and choose “Bridged Adapter” in the “Attached to:” drop-down menu and press “OK”
I have explained the reason behind using these network settings in detail in this article, you can go ahead and read that if you are into computer networks.
The short explanation is, we will not be able to access the GitLab server from our other machines on the network unless we choose this option.
That’s it, the configuration is done!
You can now go ahead and click the start button!
Now the installation process will start. Since we have chosen to go with “Ubuntu server” in order to minimize the resource consumption (so that GitLab can take up as many resources as it needs) we don’t get a fancy Graphical UI, like in the desktop version of Ubuntu. You need to navigate the menus during installation only using Keyboard (tab, enter and arrow keys) since the Ubuntu server doesn’t come with mouse support. So go through the process and get it done.
STEP#4: Get the IP address of your ubuntu server
Okay now
once you got the Ubuntu server up and running, you need to find its IP address
and make a note of it.
To do that, use the “ifconfig” command on your Ubuntu server’s terminal
STEP#5: Download and install GitLab server
To download GitLab server, go to the official link on the Gitlab’s Website
As you can see GitLab official supports several Linux distros, even a Raspberry Pi 2’s Raspbian! We are interested in Ubuntu, so click on the Omnibus Ubuntu Link on as shown in the screenshot above.
Once you click on Ubuntu, the commands you need to enter to install GitLab server will be shown to you.
I am not showing each instruction here since GitLab updates the information presented on their website all the time and that can make this section of the article outdated. Just follow the step by step instructions given in the link to install the GitLab Server on your VM.
Just type in the commands shown there on you Ubuntu server’s terminal one by one to get GitLab Server installed.
A couple of tips on the GitLab installation instructions
Tip#1
In the postfix installation step (step 1 last command on the GitLab website)
sudo apt-get install -y postfix
you can skip the mail option by choosing the “no configuration” option as shown in the screenshot below.
Tip#2
In the last command of step 2 at GitLab website
sudo EXTERNAL_URL="https://gitlab.example.com" apt-get install gitlab-ee
Make sure you replace the URL with the IP address of the VM that we have made a note of in Step 5 above like this
sudo EXTERNAL_URL="192.168.0.116" apt-get install gitlab-ee
Or to be more precise just place the VM’s IP address that we obtained in Step#4 in its appropriate place
sudo EXTERNAL_URL=”<Your VM’s IP address>” apt-get install gitlab-ee
This step will take a while, so be patient. In my machine it took 4 minutes 48 seconds as shown in the screenshot below, yours can vary depending on the processing power it has.
Once done it will show u something like in the screenshot below.
Once it’s done, you can go ahead to your favorite browser and type in the IP address of your VM and check if the installation has succeeded.
And voila! GitLab server installation has succeeded!
Go ahead and follow the onscreen instructions to set up your password, accounts and everything else!
STEP#6: Download GitLab runners
Before installing GitLab runners you need to install Git on your Windows PC. You can download the latest version of Git in this link.
Now that we have set up the Gitlab server and Git, the next step is to set up the GitLab runner!
At the time of writing this article, the installation process goes like this:
Make a folder on your computer and go to either this link for 32bit version or this link for 64bit version to download the binaries and put them in the folder you created
For getting the most up to date instruction, I am gonna ask you to follow the process given in the GitLab website
STEP#7: Connect the GitLab server to the GitLab runner
GitLab
calls this process of connecting the Server to Runner as “Registering the
GitLab Runner to the Server”
You can follow the instructions for Windows in this link to do the same.
Scroll down to the windows section and you will see something similar to this
Step# 7.1: Start the registration process
To enter these commands you need to open a command prompt with administrator privileges. For this just type cmd on the search menu, right-click on Command prompt and choose run as administrator
After that, just go to the folder to which you have downloaded the Gitlab Runner to and copy the path to that folder
Next, go back to the command line and give the following command
cd <path you copied>
Run the following command to start the registration process
gitlab-runner-windows-amd64.exe register
As shown in the screenshots above, enter your Virtual Machine’s IP address when prompted. Make sure you add “http://” before the IP address.
Once the IP address is entered, the next prompt appears asking you to enter a token, so let’s first go get a token from our GitLab server.
Step#7.2: Obtain token from GitLab Server
Go to your browser and enter the GitLab Server’s IP address. Once you have logged in you can create your first project by clicking on the respective pane as shown in the screenshot below.
Just give the project a name and click on the create project button. The other field should get populated automatically.
Once you click the button as shown in the screenshot above, you will be taken to your project page.
From there just click on Settings->CI/CD and scroll down a bit and click the “Expand” button next to “Runners” and you will find the token you need as shown in the screenshot below.
This token basically connects your project on the GitLab Server to the GitLab runner.
Step#7.3: Enter the token
Now that we have the token let’s enter it on the Command prompt
Once
entering the token, you will be prompted to give the runner a description, go
ahead and do that.
After that, you will be asked to enter some tags.
What are tags? Why are they needed for GitLab runners?
The
better term for tags can be capabilities.
Consider
this scenario.
Assume you are working in a large team of 1000 developers, who are doing say 50 different projects and your GitLab system has 100 different runners set up with several capabilities to do specific tasks. Some projects may need C compilers, while others may need python interpreters.
Now in order to connect a given project with a free-runner, we need some sort of parameter to tell the GitLab server that this particular free runner is capable of running the scripts needed for that particular job.
This is where tags come into the picture. By giving tags like “C” or “Python” a single runner can be connected to multiple projects and a single project can execute its jobs on several runners to ensure the best possible performance.
Using
these tags the Gitlab server can find a runner with the specific capability to
use for a given job. So give some suitable tags that will imply the
capabilities of your runner.
Once that is done, you will be prompted to enter “executor”.
Executors are programs that run our CI/CD scripts. Type shell and press enter
This will end the registration process the Runner to the server
Once registered you can start the GitLab runner as a Service (background task) by issuing the commands
gitlab-runner-windows-amd64.exe install gitlab-runner-windows-amd64.exe start
As you can see in the screenshot below, in the task manager app we can see that our gitlab-runner service is running!
Test to see if everything works
By following the 7 steps above, you should have a set up with GitLab Server and Runner running on your system. Its time to test and see if everything works the way it is supposed to work!
First, let’s test the GitLab server by creating a repo and pushing it to the server.
Testing GitLab Server
STEP#1: Make a test git repo
Let’s make a simple git repo on a new folder on our Desktop and push it to the GitLab server.
So open your Git-Bash app, which got installed as you were installing git.
Once opened type in the following commands
cd cd Desktop mkdir test_project cd test_project touch test.c
The above lines of command are just the fancy way of creating a folder named test_project on your Desktop and a file named test.c inside it. You can also do it through the Graphical User Interface if you want to.
So next, please open the C file using your favorite text editor and type in a simple program for testing, something like the following.
#include <stdio.h>
int main()
{
printf("Hello Embedded Inventors!");
return 0;
}
Next, let’s initialize a git repository on our test_project folder. So go back to the terminal cd into the test_project folder and type in the following command
You should receive a reply saying “Initialized empty Git repository”
STEP#2: Push it to the server
Now that we have our git repo ready, let’s push it to our git server. To do that login to your GitLab and go to the project we created earlier. There GitLab shows us the commands needed to push our repo to the server.
First, let’s configure our name and email on the git repository to the ones set on the GitLab server
So enter
the following command.
git config --global user.name "<enter your name here>" git config --global user.email "<enter your email here>"
Next, we need to connect our server and our repository. To do that just enter the following commands
git remote add origin <your project URL>.git
In my case it is
git remote add origin http://192.168.0.115/EI/test-project.git
To find your project URL, just copy the address bar of your browser while you are on your project’s page in GitLab
Then add our test.c file and commit the changes using the following commands
git add . git commit -m"first commit"
Then push
your git repo onto the GitLab using the command
git push -u origin master
You will be prompted to enter the user name and password of your GitLab account, once done go to your browser and just refresh the page and you should be able to see your test project page in GitLab!
Testing GitLab Runner
STEP#3: Make a simple bash script to build the test.c
file
Create a bash script on your project folder
cd cd Desktop/test_project touch build.ps1
Edit it so that it looks something like this
gcc test.c -o test echo "Build completed"
STEP#4: Create and edit .gitlab_ci.yml to run the
above script
What is .gitlab-ci.yml and why it is needed? This is the file that contains the instructions for the GitLab runners to execute the CI/CD tasks. It should be present in the project’s root folder. It can be used to test if a commit builds correctly, passes some unit tests and if it needs packaging and deployment.
You can
learn more about how to configure it from the official quick start tutorial
here
For the
purpose of testing our installation let’s create a file named .gitlab-ci.yml in
the test_project folder and put the following lines in there.
Make sure you are in the right directory
cd cd Desktop/test_project
Create the file using the command
Open it with your favorite text editor and type the following lines into it.
build:
script:
- powershell -File build.ps1
tags:
- test
The last line tells the GitLab server to use the GitLab runner with the tag named “test”. If you gave your GitLab runner installation a different tag, make sure you make the appropriate change to the above lines.
Also,
make sure you use spaces instead of tabs at the beginning of the above lines.
Now add it to the git repository and push it to the Gitlab server
git add . git commit -m"gitlab yml added" git push
Now let’s get back to our GitLab server’s URL and see if it worked. Go to the project page and click on CI/CD
You will
be taken to the pipeline page which shows the result of your latest commit.
It will
take a minute or so before it completes the pipeline and as you can see in the
screenshot above, mine took 41 seconds to complete and the status is
“passed”
If you
click on “jobs” under the CI/CD menu, you will be taken to another
page which shows you more information about the execution of our yml file
Next click on “passed” as shown in the screenshot above, this will take you to another page which will look something like this.
As you can see, our build.ps1 gets executed by the GitLab runner and it succeeds to compile our project.
And with that, I will conclude this tutorial!
I leave the rest to you to play, explore, experiment and learn GitLab!
I hope you guys enjoyed this article and learned something useful.
You can email us or contact us through this link if you have any questions or suggestions.
If you liked the post, feel free to share this post with your friends and colleagues!
GITLAB
GitLab is a popular web-based Git repository manager that allows developers to collaborate on code, manage projects, and automate software lifecycles. With its integrated CI/CD pipelines, issue tracking, and version control features, GitLab enhances collaboration among teams and streamlines development processes. In this article, we will guide you through the process of setting up GitLab on a Windows operating system, providing you with a step-by-step approach to get it up and running.
Prerequisites
Before starting the installation of GitLab on your Windows machine, make sure you have the following prerequisites in place:
-
Windows 10 or 11: GitLab can be set up on modern Windows operating systems.
-
Minimum System Requirements:
-
4 GB RAM (8 GB recommended)
-
At least 2 CPU cores
-
At least 20 GB of free disk space
-
-
Windows Subsystem for Linux (WSL): To run GitLab on Windows, you need to enable WSL and install a compatible Linux distribution (like Ubuntu).
Step 1: Install Windows Subsystem for Linux (WSL)
-
Enable WSL:
-
Open PowerShell as an administrator.
-
Run the command:
-
This command installs WSL and the default Ubuntu distribution. Restart your computer if prompted.
-
-
Install a Linux Distribution:
-
If you want to install a specific version of Ubuntu, you can open the Microsoft Store and search for “Ubuntu” or run:
-
Then install your preferred version using:
wsl --install -d <DistributionName>
-
-
Set Up Ubuntu:
-
Launch Ubuntu from the Start menu, and complete the initial setup by creating a username and password.
-
Step 2: Update and Upgrade Ubuntu
Once you have Ubuntu running, it’s a good practice to update your package lists and upgrade any installed packages. Open your Ubuntu terminal and run:
sudo apt update
sudo apt upgrade -y
Step 3: Install Required Dependencies
GitLab has several dependencies that need to be installed. You can install them using the following command:
sudo apt install -y curl openssh-server ca-certificates tzdata perl
Additionally, for GitLab to work smoothly, you need to enable the Postfix mail server. This is essential for sending notification emails from your GitLab instance.
sudo apt install -y postfix
When prompted, select “Internet Site” and set the mail name to your system’s FQDN (Fully Qualified Domain Name).
Step 4: Install GitLab
-
Add the GitLab Package Server:
First, you will need to add the GitLab package repository to your system. Execute the following commands one by one:
curl https://packages.gitlab.com/install/repositories/gitlab/gitlab-ce/script.deb.sh | sudo bash
-
Install GitLab CE:
You can install GitLab Community Edition using the following command. Make sure to replacehttp://gitlab.example.comwith your actual domain or IP address.
sudo EXTERNAL_URL="http://gitlab.example.com" apt-get install gitlab-ce
-
Reconfigure GitLab:
After GitLab has been installed, run the following command to reconfigure it:
sudo gitlab-ctl reconfigure
This command initializes your GitLab server and makes the necessary configurations.
Step 5: Access GitLab
Once the configuration is complete, you can access GitLab from your web browser. Open a browser and navigate to http://gitlab.example.com (or the URL you’ve chosen).
Default Sign-in
-
The default username is
root. -
The initial password is generated during installation and can be found in your log file. You can retrieve it with:
sudo cat /etc/gitlab/initial_root_password
Log in and change your password.
Step 6: Basic Configuration
Configuring SMTP Settings
To enable email notifications, you will need to configure SMTP settings in GitLab:
-
Open the GitLab configuration file:
sudo vi /etc/gitlab/gitlab.rb
-
Locate the
gitlab_rails['smtp_settings']section, and fill it with your SMTP server details. Here’s an example configuration:
gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = "smtp.example.com"
gitlab_rails['smtp_port'] = 587
gitlab_rails['smtp_user_name'] = "your-smtp-username"
gitlab_rails['smtp_password'] = "your-smtp-password"
gitlab_rails['smtp_domain'] = "example.com"
gitlab_rails['smtp_authentication'] = "login"
gitlab_rails['smtp_enable_starttls_auto'] = true
-
Save the file and reconfigure GitLab:
sudo gitlab-ctl reconfigure
Creating a New Project
-
After logging in, click on the “New Project” button.
-
Fill in the project details, such as the project name and description.
-
Select visibility level and click on “Create project”.
Conclusion
Setting up GitLab on a Windows machine using WSL is a powerful way to leverage the collaborative capabilities of this tool directly within your Windows environment. By following the above steps, you are now equipped with your GitLab instance, ready to manage your projects efficiently.
Key Takeaways
-
Install WSL and a Linux distribution (preferably Ubuntu).
-
Keep your system packages updated.
-
Follow installation steps and configure SMTP settings for email notifications.
-
Start creating repositories and projects in GitLab.
By integrating GitLab into your development workflow, you will optimize collaboration among your team members and improve overall productivity. Happy coding!
Suggested Articles
GITLAB
GITLAB
GITLAB
GITLAB
GITLAB
GITLAB