--- title: "Install machine runner 3 on Windows" description: "Instructions on how to install CircleCI's machine runner 3 on Windows." platform: "Cloud, Server" doc_version: "unversioned" last_updated: "2026-10-14" --- > For current CircleCI product defaults, deprecated patterns, and Cloud/Server differences, see [AGENTS.md](https://circleci.com/docs/AGENTS.md). > > For the complete documentation index and site structure, see [llms.txt](https://circleci.com/docs/llms.txt). # Install machine runner 3 on Windows This page describes how to install CircleCI’s machine runner 3 on Windows. Windows Server 2016 and older are not compatible with machine runner 3. CircleCI tests machine runner 3 against Windows Server 2019, 2022, and 2025. Server SKUs with Desktop Experience and Remote Desktop Services (RDS) are compatible. The following table shows machine runner 3 compatibility by Windows Server version: | Windows Server version | Machine runner 3 | | --- | --- | | 2025 | Compatible | | 2022 | Compatible | | 2019 | Compatible | | 2016 and older | Not compatible | This page walks you through installing a machine runner and its dependencies (for example, 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 self-hosted runner instance cannot run on a Windows Server operating as a domain controller. ## Prerequisites To install machine runners and run jobs, you will need to have root access, and have the following dependencies installed on your system: * [Desktop Experience](https://learn.microsoft.com/en-us/windows-server/get-started/install-options-server-core-desktop-experience) * [Remote Desktop Services (RDS)](https://learn.microsoft.com/en-us/windows-server/remote/remote-desktop-services/remote-desktop-services-overview) * The [CircleCI CLI](https://circleci.com/docs/guides/toolkit/circleci-cli/) if you wish to install runners from the command line. Additional utilities and tools, such as Chocolatey, Git, and Gzip are automatically installed as part of the [installation script](#installation-steps). ## Self-hosted runner terms agreement Before you can install self-hosted runners through the web app, you will need to agree to the [CircleCI Runner Terms](https://circleci.com/legal/runner-terms/). To access the **Runners** section of the [CircleCI web app](https://app.circleci.com/) an organization admin must agree to the terms at **Org**  **Runners**. > **Image:** Runner terms and conditions Figure 1. Runner terms and conditions Once the terms have been accepted, **Runners** will appear permanently in the side navigation. Your role within your org is determined differently depending on how you integrate with your code, as follows: * If you have a `github` or `bitbucket` type organization, CircleCI mirrors VCS permissions for organizations. If you are an admin on your organization’s VCS, you are an admin on CircleCI. If you are unsure, [check the admin permissions](https://support.circleci.com/hc/en-us/articles/360034990033-Am-I-an-Org-Admin) on your VCS. * If you have a `circleci` type organization, you can check roles by navigating to **Org**  **People**. Full details on roles and permissions are available in the [Roles and Permissions Overview](https://circleci.com/docs/guides/permissions-authentication/roles-and-permissions-overview/). Find out about organization types in the [Users, Organizations and Integrations Guide](https://circleci.com/docs/guides/permissions-authentication/users-organizations-and-integrations-guide/). If you are installing and using self-hosted runners through the CLI, you are agreeing to the [CircleCI Runner Terms](https://circleci.com/legal/runner-terms/). ## 1\. Create namespace and resource class To install self-hosted runners, you need to create a CircleCI namespace and resource class. Once set up you will receive a resource class token. You must be an organization admin to complete this process. View your installed runners on the inventory page in the [web app](https://app.circleci.com/) by selecting **Runners** from the sidebar. If you already create orb in your organization you will already have a namespace configured. You must use this same namespace for runners. Each organization can only create a single namespace. 1. On the [CircleCI web app](https://app.circleci.com/), navigate to **Runners** and select **Create Resource Class**. > **Image:** Runner set up Figure 2. Runner set up, step one - Get started 2. Create a custom [Resource Class](https://circleci.com/docs/guides/execution-managed/resource-class-overview/). You will configure jobs to use this resource class when you want them to run on your self-hosted runner. We suggest using a lowercase representation of your CircleCI account name for your namespace. CircleCI will populate your org name as the suggested namespace by default in the UI. Namespace and resource classes must follow specific naming conventions: * The **namespace** can contain lowercase letters, numbers, underscores, and dashes. * The **resource class name** can contain uppercase and lowercase letters, numbers, colons, underscores, dashes, and plus signs. > **Image:** Runner set up Figure 3. Runner set up, step two - Create a namespace and resource class 3. Enter a description for your resource class. The description is an optional field. 4. Select **Save and continue** to save and view your resource class token. 5. Copy and save the resource class token. Self-hosted runners use this token to claim work for the associated resource class. The token is only displayed once, be sure to store it safely. > **Image:** Runner set up Figure 4. Runner set up, step three - Create a resource class token 6. Select the **Machine** tab and progress on to the platform-specific instructions in the next section of this installation guide. If you are installing **self-hosted runners for server**, the CircleCI CLI needs to be configured using your server API key. Run `circleci setup` to configure the CLI and access the option to supply a new API token if required. To install self-hosted runners, you need to create a CircleCI namespace and resource class. Once set up you will receive a resource class token. You must be an organization admin to complete this process. View your installed runners on the inventory page in the [web app](https://app.circleci.com/) by selecting **Runners** from the sidebar. If you already create orb in your organization you will already have a namespace configured. You must use this same namespace for runners. Each organization can only create a single namespace. 1. Create a namespace for your organization’s self-hosted runners if you do not already have one configured. We suggest using a lowercase representation of your CircleCI organization’s account name. Use the following command to create your CircleCI organization’s namespace: ```console $ circleci namespace create --org-id ``` 2. Create a resource class for your runner using the following command. You will configure jobs to use this resource class when you want them to run on your slef-hosted runner: ```console $ circleci runner resource-class create / --generate-token ``` Make sure to replace `` and `` with your org namespace and desired resource class name, respectively. You can add a description but this is optional. Resource class names must follow specific naming conventions. * The **namespace** can contain lowercase letters, numbers, underscores, and dashes. * The **resource class name** can contain uppercase and lowercase letters, numbers, colons, underscores, dashes, and plus signs. The resource class token is returned after the runner resource class is successfully created. The token is only displayed once, so be sure to store it safely. ## 2\. Machine runner installation on Windows 1. Download the [`Install-CircleCIRunner.ps1` script](https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner) from GitHub to an accessible location. 2. Open PowerShell as an administrator and navigate to the directory where you placed the script file. 3. Run the following in your PowerShell: ```powershell Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; ./Install-CircleCIRunner.ps1 ``` The installation will be displayed in your PowerShell interface. 4. As part of the installation, the configuration file for the machine runner (`runner-agent-config.yaml`) will open in Notepad. Fill in the requested information (see [Machine Runner 3.0 Configuration Reference](https://circleci.com/docs/runner/machine-runner-3-configuration-reference/)). The configuration file is located in the installation directory, `C:\Program Files\CircleCI`, by default. After your setup completes, the machine runner starts automatically and begins looking for jobs to process. ## Machine runner configuration example Once you have installed the runner, select **Continue** in the CircleCI web app. You will be presented with an example configuration snippet showing a job configured to use your new self-hosted runner resource class. > **Image:** Runner set up Figure 5. Runner set up, copy code to config file The fields you must set for a specific job to run using your machine runners are: * `machine: true` * `resource_class: /` Simple example of how you could set up a job: ```yaml version: 2.1 workflows: build-workflow: jobs: - runner jobs: runner: machine: true resource_class: / steps: - run: echo "Hi I'm on Runners!" ``` The job will then execute using your self-hosted runner when you push the `.circleci/config.yml` to your VCS provider. ## Uninstall / reinstall steps Uninstalling machine runners will prepare the system for installation again. 1. Download the [`Uninstall-CircleCIRunner.ps1` script](https://github.com/CircleCI-Public/runner-installation-files/tree/main/windows-install/circleci-runner) from GitHub to an accessible location. 2. Open PowerShell as an administrator and navigate to the directory where you placed the script file. 3. Run the following in your PowerShell: ```powershell ./Uninstall-CircleCIRunner.ps1 ``` ## Continuous mode vs. single task mode for Windows self-hosted runners By default, Windows machine runners run in [Single-Task Mode](https://circleci.com/docs/runner/machine-runner-3-configuration-reference/#runner-mode) in order to ensure high reliability of the underlying technology that the self-hosted runner uses to execute jobs. Single-task mode is the **recommended mode** for Windows machine runners. A Windows machine runner **can** be run in `continuous` mode. However, doing so eliminates the guarantee of a clean job environment. This may translate into jobs not executing as expected, and job failures. ## Troubleshooting Refer to the [Troubleshoot Machine Runner](https://circleci.com/docs/runner/troubleshoot-self-hosted-runner/#machine-runner) guide if you encounter issues installing or running machine runner on Windows. ## Additional resources * [Manual Installation for Machine Runner 3 on Windows](https://circleci.com/docs/runner/machine-runner-3-manual-installation-on-windows/) * [Machine Runner 3 Linux Package Installation](https://circleci.com/docs/runner/install-machine-runner-3-on-linux/) * [Machine Runner 3 macOS Homebrew Installation](https://circleci.com/docs/runner/install-machine-runner-3-on-macos/) * [Machine Runner 3 Docker Installation](https://circleci.com/docs/runner/install-machine-runner-3-on-docker/) * [Machine Runner 3 Configuration Reference](https://circleci.com/docs/runner/machine-runner-3-configuration-reference/)