Setting up a Self Hosted Github Runner

Adding a Windows Self hosted Github Runner

Replace <<ORG_NAME>> in the following URL and paste it in the browser<<ORG_NAME>>/settings/actions/runners/new

You Need to sign in to Github org account.

1 new runner setup on windows

Downloading the Github Actions Runner on Windows and Extract it

Note that the suggested location for downloading the github runner on Windows is the Root Drive C:

# Create folders
New-Item -Path "C:\actions-runner" -ItemType Directory
Set-Location "C:\actions-runner"

# Download the zip file
Invoke-WebRequest -Uri -OutFile

# Check hash
if((Get-FileHash -Path -Algorithm SHA256).Hash.ToUpper() -ne '2368cd782c5b0dba1af8f90e1cc1c294cce2d165ed24f026577304b66440b31e'.ToUpper()){ throw 'Computed checksum did not match' }

# Extract the zip file
Add-Type -AssemblyName System.IO.Compression.FileSystem ; [System.IO.Compression.ZipFile]::ExtractToDirectory("$PWD/", "$PWD")

Registering the Host as Self hosted github runner


Generate the <<TOKEN>> using Github REST API and replace it in the command shown below

Checkout for a way to use Github's REST API to generate the token

Otherway would be to pick it up from the webpage as explained the first section under Configure section after the --token argument to config.cmd

1 new runner setup on windows

Single Command

Following is a single command that will

  • Register as self-hosted github runner
  • Actions runner, running as a Windows Service => Automatically starts on reboots

You can run the following command with appropriate values replaced for the host to automatically

C:/actions-runner/config.cmd --url<<ORG_NAME>> --token <<TOKEN>> --unattended --runasservice --runnergroup <<RUNNER_GROUP>> --labels '<<COMMA_SEPARATED_ADDITIONAL_LABELS>>'' --windowslogonaccount <<WINDOWS_LOGIN_USERNAME>> --windowslogonpassword <<WINDOWS_LOGIN_PWD>> --work _work

Latest Blogposts

Storing Github access token in git credential store

Using git credentials store the github access token to avoid the re-prompting of username and pwd

4 April 2023

Token generation for Registering Self Hosted Github Runner via REST API

Explains how to generate a token using github API to be used in turn with Github self hosted runner registration

21 March 2023

Managing the NodeJS versions on Windows

Node Version Manager (nvm) helps in managing multiple NodeJS versions

13 November 2022

Customizing the Powershell terminal with oh-my-posh

Instructions on customizing the terminal in powershell with oh-my-posh and winget

7 July 2022