> For the complete documentation index, see [llms.txt](https://circleci.com/docs/llms.txt)

# Install machine runner 3 on Linux

This page describes how to install CircleCI’s machine runner 3 on Linux.

## Prerequisites

To install machine runners and run jobs, you will need to have root access, and have the following utilities and tools installed on your system:

*   [Coreutils](https://www.gnu.org/software/coreutils/)
    
*   [curl](https://curl.se/)
    
*   sha256sum (if not pre-installed):
    
    *   `sudo apt install coreutils` for Ubuntu/Debian
        
    *   `sudo yum install coreutils` for Red Hat
        
    
*   [tar](https://www.gnu.org/software/tar/)
    
*   [Gzip](https://www.gnu.org/software/gzip/)
    
*   `sepolicy` ([RHEL 8](https://www.redhat.com/en/enterprise-linux-8/details) only)
    
*   `rpmbuild` ([RHEL 8](https://www.redhat.com/en/enterprise-linux-8/details) only)
    
*   [GPG 2.1+](https://gnupg.org/download/)
    
*   The [CircleCI CLI](https://circleci.com/docs/guides/toolkit/circleci-cli/) if you wish to install runners from the command line.
    

## Self-hosted runner terms agreement

<Tabs>
<Tab title="Web app installation">

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/).

</Tab>
<Tab title="CLI installation">

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/).

</Tab>
</Tabs>

## 1\. Create namespace and resource class

<Tabs>
<Tab title="Web app installation">

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. This 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.

</Tab>
<Tab title="CLI installation">

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 <name> --org-id <your-organization-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 <namespace>/<resource-class> <description> --generate-token
    ```
    
    Make sure to replace `<namespace>` and `<resource-class>` 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.

</Tab>
</Tabs>

## 2\. Install CircleCI runner

<Tabs>
<Tab title="Debian">

The easiest way to install runner on a Debian or Ubuntu system is to use CircleCI’s pre-built packages.

1.  On the target machine, install the CircleCI registry. This script will automatically run `apt-get update`:
    
    ```shell
    curl -s https://packagecloud.io/install/repositories/circleci/runner/script.deb.sh?any=true | sudo bash
    ```
    
2.  Next, install the `circleci-runner` package:
    
    ```shell
    sudo apt-get install -y circleci-runner
    ```
    
3.  Replace `<< AUTH_TOKEN >>` with the token generated in the steps above. You may use your text editor to do this, or edit and run the following commands to replace the token automatically:
    
    ```shell
    export RUNNER_AUTH_TOKEN="your-runner-auth-token-here"
    sudo sed -i "s/<< AUTH_TOKEN >>/$RUNNER_AUTH_TOKEN/g" /etc/circleci-runner/circleci-runner-config.yaml
    ```
    
4.  **If you are using CircleCI Server** you will need to provide the URL for your installation. You can do this by either setting the `CIRCLECI_RUNNER_API_URL` environment variable:
    
    ```shell
    export CIRCLECI_RUNNER_API_URL="your server domain"
    ```
    
    Or by adding the URL to `/etc/circleci-runner/circleci-runner-config.yaml` using text editor of your choice.
    
    ```yaml
    api:
      auth_token: << AUTH_TOKEN >>
      # On server, set url to the hostname of your server installation.
      url: https://your.domain.here
    ```
    
5.  Start the `circleci-runner service`, and check that it is currently running:
    
    ```shell
    sudo systemctl enable circleci-runner && sudo systemctl start circleci-runner
    
    # Check status
    sudo systemctl status circleci-runner
    ```

</Tab>
<Tab title="rpm">

The easiest way to install runner on a Red Hat, CentOS, or Fedora system is to use CircleCI’s pre-built packages.

1.  On the target machine, install the CircleCI registry:
    
    ```shell
    curl -s https://packagecloud.io/install/repositories/circleci/runner/script.rpm.sh?any=true | sudo bash
    ```
    
2.  Next, install the `circleci-runner` package:
    
    ```shell
    sudo yum install circleci-runner -y
    ```
    
3.  Replace `<< AUTH_TOKEN >>` with the token generated in the steps above. You may use your text editor to do this, or edit and run the following commands to replace the token automatically:
    
    ```shell
    export RUNNER_AUTH_TOKEN="your-runner-auth-token-here"
    sudo sed -i "s/<< AUTH_TOKEN >>/$RUNNER_AUTH_TOKEN/g" /etc/circleci-runner/circleci-runner-config.yaml
    ```
    
4.  Enable and start the `circleci-runner service`, and check that it is currently running:
    
    ```shell
    sudo systemctl enable circleci-runner && sudo systemctl start circleci-runner
    
    # Check status
    sudo systemctl status circleci-runner
    ```

</Tab>
</Tabs>

## 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: <namespace>/<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: <namespace>/<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.

## Troubleshooting

Refer to the [Troubleshoot Machine Runner section](https://circleci.com/docs/guides/execution-runner/troubleshoot-self-hosted-runner/#machine-runner) of the Troubleshoot Self-hosted Runner guide if you encounter issues installing or running machine runner on Linux.

## Additional resources

*   [Machine Runner 3 macOS Homebrew Installation](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-macos/)
    
*   [Machine Runner 3 Windows Installation](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-windows/)
    
*   [Machine Runner 3 Docker Installation](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-docker/)
    
*   [Manual Installation for Machine Runner 3](https://circleci.com/docs/guides/execution-runner/machine-runner-3-manual-installation/)
    
*   [Machine Runner 3 Configuration Reference](https://circleci.com/docs/guides/execution-runner/machine-runner-3-configuration-reference/)