GitLab Documentation

Install on Windows

To install GitLab Runner on Windows, your user must have a password set up.

Installation

  1. Create a folder somewhere in your system, ex.: C:\Multi-Runner.

  2. Download the binary for x86 or amd64 and put it into the folder you created.

  3. Run an Administrator command prompt (How to). The simplest is to write Command Prompt in Windows search field, right click and select Run as administrator. You will be asked to confirm that you want to execute the elevated command prompt.

  4. Register the Runner (look into Runners documentation to learn how to obtain a token):

    cd C:\Multi-Runner
    gitlab-ci-multi-runner register
    
    Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com )
    https://gitlab.com
    Please enter the gitlab-ci token for this runner
    xxx
    Please enter the gitlab-ci description for this runner
    my-runner
    INFO[0034] fcf5c619 Registering runner... succeeded
    Please enter the executor: shell, docker, docker-ssh, ssh?
    docker
    Please enter the Docker image (eg. ruby:2.1):
    ruby:2.1
    INFO[0037] Runner registered successfully. Feel free to start it, but if it's
    running already the config should be automatically reloaded!
    
  5. Install the Runner as a service and start it. You have to enter a valid password for the current user account, because it's required to start the service by Windows:

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

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

Voila! Runner is installed and will be run after system reboot. Logs are stored in Windows Event Log.

Update

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

    cd C:\Multi-Runner
    gitlab-ci-multi-runner stop
    
  2. Download the binary for x86 or amd64 and replace runner's executable.

  3. Start the service:

    gitlab-ci-multi-runner start
    

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

Troubleshooting

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

gitlab-ci-multi-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 into FAQ to check how to resolve the problem.

If you don't have a Windows Password, Runner's service won't start. To fix this please read How to Configure the Service to Start Up with the Built-in System Account on Microsoft's support website.