CircleCI Runner Installation on Windows
This page describes how to install CircleCI runner on Windows.
|Please review the Installing the CircleCI Runner page to verify prerequisites and authentication.|
|This has been tested for Windows Server 2019 and Windows Server 2016, both in Datacenter Edition with Desktop Experience.|
With this procedure, you install CircleCI launch agent and its dependencies, i.e., Chocolatey, Git and Gzip, on your Windows Server.
Since this setup creates a new local administrator user that runs CircleCI jobs, your Windows Server needs to be capable of creating local users and accepting remote logons for them.
The Windows Server needs to be a domain member when you set this up in domain environments. The runner instance cannot run on a Windows Server operating as a domain controller.
Install-CircleCIRunner.ps1script from Github to an easily accessible location.
Open PowerShell as an administrator and navigate to the directory where you placed the script file.
Run the following in your PowerShell:
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; ./Install-CircleCIRunner.ps1
The installation will be output into your PowerShell interface.
As part of the installation, the configuration file for the Runner (
launch-agent-config.yaml) will open in Notepad. Please fill the file out with the requested information (see Runner Configuration Reference). The configuration file is located in the installation directory -
C:\Program Files\CircleCI, by default.
After setup completes, the launch agent starts automatically and begins looking for jobs to process.
Help make this document better
This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guide first).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.