GitLab Documentation

Install GitLab Runner on Windows

To install and run GitLab Runner on Windows you need:

Installation

Important: With GitLab Runner 10, the executable was renamed to gitlab-runner. If you want to install a version prior to GitLab Runner 10, visit the old docs.
  1. Create a folder somewhere in your system, ex.: C:\GitLab-Runner.
  2. Download the binary for x86 or amd64 and put it into the folder you created. Rename the binary to gitlab-runner.exe. You can download a binary for every available version as described in Bleeding Edge - download any other tagged release.
  3. Run an Administrator/elevated command prompt (WindowsKey + X then select Command Prompt (Admin)).
  4. Register the Runner.
  5. Install the Runner as a service and start it. You can either run the service using the Built-in System Account (recommended) or using a user account.

    Run service using Built-in System Account

    gitlab-runner install
    gitlab-runner start
    

    Run service using user account

    You have to enter a valid password for the current user account, because it's required to start the service by Windows:

    gitlab-runner install --user ENTER-YOUR-USERNAME --password ENTER-YOUR-PASSWORD
    gitlab-runner start
    

    See the troubleshooting section if you encounter any errors during the Runner installation.

  6. (Optional) Update Runners concurrent value in C:\GitLab-Runner\config.toml to allow multiple concurrent jobs as detailed in advanced configuration details. Additionally you can use the advanced configuration details to update your shell executor to use Bash or PowerShell rather than Batch.

Voila! Runner is installed, running, and will start again after each system reboot. Logs are stored in Windows Event Log.

Update

  1. Stop the service (you need elevated command prompt as before):

    cd C:\GitLab-Runner
    gitlab-runner stop
    
  2. Download the binary for x86 or amd64 and replace runner's executable. You can download a binary for every available version as described in Bleeding Edge - download any other tagged release.

  3. Start the service:

    gitlab-runner start
    

Uninstall

From elevated command prompt:

cd C:\GitLab-Runner
gitlab-runner stop
gitlab-runner uninstall
cd ..
rmdir /s GitLab-Runner

Troubleshooting

Make sure that you read the FAQ section which describes some of the most common problems with GitLab Runner.

If you encounter an error like The account name is invalid try to add .\ before the username:

gitlab-runner install --user ".\ENTER-YOUR-USERNAME" --password "ENTER-YOUR-PASSWORD"

If you encounter a The service did not start due to a logon failure error while starting the service, please look in the FAQ to check how to resolve the problem.

If you don't have a Windows Password, Runner's service won't start but you can use the Built-in System Account.

If you have issues with the Built-in System Account, please read How to Configure the Service to Start Up with the Built-in System Account on Microsoft's support website.



Last updated 2017-10-09