--- title: "Install machine runner 3 on Docker" description: "Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker." 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 Docker This page describes how to install CircleCI’s machine runner 3 with the Docker executor. If you are looking to set up self-hosted runners in a private Kubernetes cluster, visit the [Container runner](https://circleci.com/docs/runner/container-runner-installation/) page. [Container Runner](https://circleci.com/docs/runner/container-runner/) is the **recommended method** for self-hosted runner Docker installation. The instructions on this page are for a simple Docker setup using machine runner 3. Container runner is the recommended approach for running containerized jobs on self-hosted runners. Container runner offers the ability to seamlessly define, publish, and use custom Docker images during job execution. Container runner also has the ability to manage dependencies or libraries through custom Docker images instead of enumerating dependencies as part of `steps` in the `.circleci/config.yml` file. ## Machine-based approach with Docker ### Prerequisites * [Docker](https://docs.docker.com/engine/install/) #### Resource requirements The host needs to have Docker installed. Once the `runner` container is started, the container will immediately attempt to start running jobs. The container will be reused to run more jobs indefinitely until it is stopped. The number of containers running in parallel on the host is constrained by the host’s available resources and your jobs' performance requirements. ### 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\. Create a Dockerfile that extends the machine runner 3 image Create a `Dockerfile.runner.extended` file. In this example, Python 3 is installed on top of the base image. ```docker FROM circleci/runner-agent:machine-3 RUN sudo apt-get update; \ sudo apt-get install --no-install-recommends -y \ python3 ``` ### 3\. Build the Docker image ```shell docker build --file ./Dockerfile.runner.extended . ``` ### 4\. Start the Docker container The environment variable values are not available to the `docker` command, so these environment variables are not visible in `ps` output. ```shell CIRCLECI_RUNNER_NAME= CIRCLECI_RUNNER_API_AUTH_TOKEN= docker run --env CIRCLECI_RUNNER_NAME --env CIRCLECI_RUNNER_API_AUTH_TOKEN --name ``` When starting the Docker container on server, the `CIRCLECI_RUNNER_API_URL` environment variable will also need to be passed in using the `--env` flag. ```shell CIRCLECI_RUNNER_NAME= CIRCLECI_RUNNER_API_AUTH_TOKEN= CIRCLECI_RUNNER_API_URL= docker run --env CIRCLECI_RUNNER_NAME --env CIRCLECI_RUNNER_API_AUTH_TOKEN --env CIRCLECI_RUNNER_API_URL --name ``` When the container starts, it will immediately attempt to start running jobs. ### Stopping the Docker container ```shell docker stop ``` ### Remove the Docker container In some cases you might need to fully remove a stopped machine runner container from the system, such as when recreating a container using the same name. ```shell docker stop ; docker rm ; ``` ### Migrating from launch agent In machine runner 3, the environment variable name prefix has changed from `LAUNCH_AGENT_` to `CIRCLECI_RUNNER_`. To migrate from launch agent to machine runner 3 on Docker, stop and remove the launch agent containers and replace them with machine runner 3 containers. The commands described above can be used to accomplish this. ## 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. ## Additional resources * [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 Windows Installation](https://circleci.com/docs/runner/install-machine-runner-3-on-windows/) * [Machine Runner 3 Configuration Reference](https://circleci.com/docs/runner/machine-runner-3-configuration-reference/)