{"id":19404315,"url":"https://github.com/hasithaishere/github-runner","last_synced_at":"2025-11-18T01:02:58.515Z","repository":{"id":96571962,"uuid":"548268431","full_name":"hasithaishere/github-runner","owner":"hasithaishere","description":"Docker Based Custom (Self-Hosted) Github Runner","archived":false,"fork":false,"pushed_at":"2022-10-10T12:04:29.000Z","size":21,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-25T00:37:02.521Z","etag":null,"topics":["docker","github-runner","github-runners","gtihub-actions","self-hosted","self-hosted-runner"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/hasithaishere/github-runner","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hasithaishere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-09T08:12:47.000Z","updated_at":"2022-10-11T03:14:32.000Z","dependencies_parsed_at":"2023-04-22T21:16:23.299Z","dependency_job_id":null,"html_url":"https://github.com/hasithaishere/github-runner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hasithaishere/github-runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fgithub-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fgithub-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fgithub-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fgithub-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hasithaishere","download_url":"https://codeload.github.com/hasithaishere/github-runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fgithub-runner/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284982746,"owners_count":27095048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-17T02:00:06.431Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","github-runner","github-runners","gtihub-actions","self-hosted","self-hosted-runner"],"created_at":"2024-11-10T11:34:00.146Z","updated_at":"2025-11-18T01:02:58.498Z","avatar_url":"https://github.com/hasithaishere.png","language":"Shell","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/4580975/194851999-ca3e6db3-c5fa-4b22-b99f-549f4a9a6135.jpg\" alt=\"GitHub Runner\"/\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\u003cimg src=\"https://github.com/hasithaishere/github-runner/actions/workflows/publish-runner.yml/badge.svg\" alt=\"GitHub Runner\"/\u003e\n\u003c/div\u003e\n\u003ch1 align=\"center\"\u003eGitHub Runner\u003c/h1\u003e\n\nGenerally, Github provides free 2000 build minutes in an every month. You can use these build minutes for your personal or any other business purposes. However, sometimes that isn't enough. You might need more build minutes, which is where we come in.\n\nIn this project, we build a general purpose GitHub custom runner using Docker. So you can use these docker image to run your wn custom runner in any of your cloud provider or locally without any complexity.\n\n## Steps for building container locally\n\nBefore following this, make sure you have the prerequisites installed/fulfilled:\n\n- [Git](https://git-scm.com/downloads)\n- [Docker](https://docs.docker.com/get-docker/)\n\nNext, clone the repository and follow the steps below.\n\n```shell\ngit clone https://github.com/hasithaishere/github-runner\n```\n\nThen you can go the project root directory and execute build command\n\n```shell\ncd github-runner\nsh build.sh \u003cDocker Hub User Name\u003e \u003cDocker Hub User Password\u003e \u003cOS Name\u003e \u003cOS Version\u003e\n```\n\n\u003eIf you only want to run this in locally, so please ignore `Docker Hub User Name` and `Docker Hub User Password` arguments.\n\n\u003eIn this version this build script only support ubuntu based docker base images, os `OS Name` variable should be `ubuntu` and `OS Vesrion` need to be  basic ubuntu version ex- `20.04` or `22.04`\n\nThis you can run following docker command and see the build images in locally.\n\n```shell\ndocker images\n```\n## Pull image form Docker Hub\n\nHowever if you don't want to build the container locally you can directly pull the image from Docker Hub using following command.\n\n```shell\ndocker pull hasithaishere/github-runner\n```\n_**OR**_\n```shell\ndocker pull hasithaishere/github-runner:tag\n```\n\n## Connect Docker Runner with GitHub\n\nInitially you have to generate custom access token for connect your self-hosted runner to GitHub account.\n\n#### How to generate access token\n\nPlease follow these steps to generate custo access token.\n\n- Click on your profile icon and click on the settings in the dropdown menu.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194856355-7d4bba7e-86a0-4035-99a6-165dc76367e9.gif\" alt=\"GitHub Runner\"/\u003e\n\n\u003chr\u003e\n\n- Then go to **Developer Settings** and Click on the **Personal Access Token**.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194856352-e492981d-1fda-4316-ac90-a19aa3624c3a.gif\" alt=\"GitHub Runner\"/\u003e\n\n\u003chr\u003e\n\n- Click on the **Generate New Token** button.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194856349-c9268293-0725-4ee3-905d-b55512e74505.png\" alt=\"GitHub Runner\"/\u003e\n\n\u003chr\u003e\n\n- Then select following permissions from the list and generate the token.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194856465-13fa5ad3-c0e0-4b75-983f-107229b989ba.gif\" alt=\"GitHub Runner\"/\u003e\n\n\u003chr\u003e\n\n- Please save your token in **safe place** before close the window. Because this token you can retrieve one time only.\n\nPlease execute following command to bind the local/ cloud based runner to GitHub.\n\n#### Connect Runner With GitHub Account\n\n```shell\n#Run container from image:\ndocker run -e GH_TOKEN='\u003cYour GitHub Token\u003e' -e GH_OWNER='\u003cOrganization name/ your user name\u003e' -e GH_REPOSITORY='\u003cRepository Name\u003e' -d hasithaishere/github-runner\n```\n\nIf container has been successfully started, you can see the runner in the running container list.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194861525-88719515-33ac-4903-b6e2-dee89564ad7f.png\" alt=\"GitHub Runner\"/\u003e\n\n\n\nAnd also you can see the container in GitHub Action page's runners list.\n\n\u003cimg src=\"https://user-images.githubusercontent.com/4580975/194861516-38cce929-31ec-48de-8007-10e02080fd44.png\" alt=\"GitHub Runner\"/\u003e\n\n\u003chr\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Fgithub-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhasithaishere%2Fgithub-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Fgithub-runner/lists"}