GitLab Documentation

GitLab Runner

Build Status

GitLab Runner is the open source project that is used to run your jobs and send the results back to GitLab. It is used in conjunction with GitLab CI, the open-source continuous integration service included with GitLab that coordinates the jobs.

Requirements

GitLab Runner is written in Go and can be run as a single binary, no language specific requirements are needed.

It is designed to run on the GNU/Linux, macOS, and Windows operating systems. Other operating systems will probably work as long as you can compile a Go binary on them.

If you want to use Docker make sure that you have version v1.5.0 at least installed.

Features

Compatibility chart

Important: GitLab Runner >= 9.0 requires GitLab's API v4 endpoints, which were introduced in GitLab CE/EE 9.0. Because of this change, GitLab Runner >= 9.0 requires GitLab CE/EE >= 9.0 and will not work with older GitLab versions. The old API used by GitLab Runner was deprecated in August 2017 and with this, the v1.11.x version of GitLab Runner is deprecated as well.

In the following table you can see the compatibility chart between GitLab and GitLab Runner.

GitLab Runner / GitLab 9.0.x (03.2017) 9.1.x (04.2017) 9.2.x (05.2017) 9.3.x (06.2017) 9.4.x (07.2017) 9.5.x (08.2017) 10.0.x (09.2017)
v1.10.x
v1.11.x
v9.0.x
v9.1.x
v9.2.x
v9.3.x
v9.4.x
v9.5.x
v10.0.x

Install GitLab Runner

GitLab Runner can be installed and used on GNU/Linux, macOS, FreeBSD and Windows. You can install it using Docker, download the binary manually or use the repository for rpm/deb packages that GitLab offers. Below you can find information on the different installation methods:

Register GitLab Runner

Once GitLab Runner is installed, you need to register it with GitLab.

Learn how to register a GitLab Runner.

Using GitLab Runner

Selecting the executor

GitLab Runner implements a number of executors that can be used to run your builds in different scenarios. If you are not sure what to select, read the I am not sure section. Visit the compatibility chart to find out what features each executor supports and what not.

To jump into the specific documentation of each executor, visit:

Advanced Configuration

Troubleshooting

Read the FAQ for troubleshooting common issues.

Release process

The description of release process of the GitLab Runner project can be found in the release documentation.

Contributing

Contributions are welcome, see CONTRIBUTING.md for more details.

Development

See the development documentation to hack on GitLab Runner.

Changelog

Visit Changelog to view recent changes.

License

This code is distributed under the MIT license, see the LICENSE file.



Last updated 2017-10-09