Installing self-hosted runners with the web app

On the CircleCI web app, navigate to Self-Hosted Runners.

If this is your organization’s first time using self-hosted runners, you’ll need to create a namespace as the first part of this step. Each organization can only create a single namespace. While not required, we suggest using a lowercase representation of your CircleCI account name. CircleCI will populate your org name as the suggested namespace by default in the UI.

If your organization already use orbs, do not create a new namespace, enter the namespace your organization uses for orbs.

The second input field is to create a name for your resource class for your organization’s self-hosted runners.

Copy and save the resource class token. Self-hosted runners use this token to claim work for the associated resource class.

You will need to follow the platform-specific installation instructions to continue. There is a Container tab for setting up container runner, as well as a Machine tab for setting up self-hosted runners in Linux, macOS, and Windows. Click the tab in the UI that is relevant to your environment.

Container runner UIMachine runner UI

You will be presented with configuration code for your new resource class. If you have an existing .circleci/config.yml file, add your new resource class below the existing jobs section, or add the whole jobs section if one doesn’t exist in your config. If you don’t have an existing .circleci/config.yml file, you can create the file and copy all of the code over.