Developper Documentation
Remote Host
Install a Host

Install a Host

This page explains how to install a remote host uesing GitLab Runners.

Requirements

To start the installation you will need to have the following elements :

  • A PC. It may be a VM.
  • A Target (OS-Based or MCU)
  • An Internet connection for the PC
  • Necessary hardware to connect the Target to the PC (Ethernet dongle, USB cables, …)
  • Recommended : Ubuntu 22.04 for the operating system (you may use any other system that is supported by GitLab Runner and Docker).
👾
Tip: You may install GitLab Runner and docker directly on your target if it is possible. This remove the need of an extra PC and the need for communication between the Target and the Host. (The Target is the Host too).

Installation

Here is all the software that need to be installed on the host.

Update

Start by update your system with :

sudo apt update

Install GitLab Runner

If you are installing GitLab Runner on another system use GitLab Runner official documentation.

Add the official GitLab repository :

curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash

Install the latest version of GitLab Runner :

sudo apt-get install gitlab-runner

Install Docker

If you are installing docker on another system use docker official documentation.

Install a few prerequisite packages :

sudo apt install apt-transport-https ca-certificates curl software-properties-common

Then add the GPG key for the official Docker repository to your system:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

Add the Docker repository to APT sources:

sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"

Install docker :

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Finally, make sure your user has access to docker. You may need to add docker to your user group.

Remote HostRegister a Runner