{"id":20872397,"url":"https://github.com/romnn/github-actions-runner-launcher","last_synced_at":"2026-05-12T07:33:29.783Z","repository":{"id":57542985,"uuid":"262023598","full_name":"romnn/github-actions-runner-launcher","owner":"romnn","description":"automatic setup and registration of bare-metal GitHub actions runner instances.","archived":false,"fork":false,"pushed_at":"2020-09-09T14:21:11.000Z","size":57,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-19T08:43:39.709Z","etag":null,"topics":["action-runners","actions","bare-metal","ci","cloud-native","devops","github","provisioning","runners","self-hosted","setup"],"latest_commit_sha":null,"homepage":"","language":"Go","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/romnn.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}},"created_at":"2020-05-07T10:47:18.000Z","updated_at":"2020-09-09T14:21:14.000Z","dependencies_parsed_at":"2022-09-26T18:31:27.434Z","dependency_job_id":null,"html_url":"https://github.com/romnn/github-actions-runner-launcher","commit_stats":null,"previous_names":["romnnn/github-actions-runner-launcher"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fgithub-actions-runner-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fgithub-actions-runner-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fgithub-actions-runner-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romnn%2Fgithub-actions-runner-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romnn","download_url":"https://codeload.github.com/romnn/github-actions-runner-launcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243247832,"owners_count":20260747,"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","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":["action-runners","actions","bare-metal","ci","cloud-native","devops","github","provisioning","runners","self-hosted","setup"],"created_at":"2024-11-18T06:19:02.739Z","updated_at":"2026-05-12T07:33:29.740Z","avatar_url":"https://github.com/romnn.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## github-actions-runner-launcher\n\n[![Build Status](https://travis-ci.com/romnnn/github-actions-runner-launcher.svg?branch=master)](https://travis-ci.com/romnnn/github-actions-runner-launcher)\n[![GitHub](https://img.shields.io/github/license/romnnn/github-actions-runner-launcher)](https://github.com/romnnn/github-actions-runner-launcher)\n[![GoDoc](https://godoc.org/github.com/romnnn/github-actions-runner-launcher?status.svg)](https://godoc.org/github.com/romnnn/github-actions-runner-launcher) [![Docker Pulls](https://img.shields.io/docker/pulls/romnn/github-actions-runner-launcher)](https://hub.docker.com/r/romnn/github-actions-runner-launcher) [![Test Coverage](https://codecov.io/gh/romnnn/github-actions-runner-launcher/branch/master/graph/badge.svg)](https://codecov.io/gh/romnnn/github-actions-runner-launcher)\n[![Release](https://img.shields.io/github/release/romnnn/github-actions-runner-launcher)](https://github.com/romnnn/github-actions-runner-launcher/releases/latest)\n\nAutomatic setup and registration of GitHub actions runner instances. If you have tried [github.com/myoung34/docker-github-actions-runner](https://github.com/myoung34/docker-github-actions-runner) or similiar options for running the action runners as docker containers for the convenience, but want to run them on bare-metal, this is just right for you!\n\nConfiguration works just like with docker-compose as shown in this `sample.yml`:\n```yaml\nversion: '3.3'\n\nservices:\n  my-runner:\n    environment:\n      REPO_URL: https://github.com/my-org/repo\n      # Use access token to automatically obtain runner tokens from the github API (see 1.)\n      ACCESS_TOKEN: \u003cMY-SECRET-GITHUB-ACCESS-TOKEN\u003e\n      # The runner token must be specified otherwise (see 2.)\n      RUNNER_TOKEN: \u003cMY-SECRET-RUNNER-TOKEN\u003e\n      RUNNER_NAME: my-runner\n      RUNNER_WORKDIR: /my/runners/work/dir\n      ORG_RUNNER: \"false\"\n      ORG_NAME: my-org\n      LABELS: linux,x64\n```\n\n**Important notes**: \n1. Youy can obtain an access token to automatically create `RUNNER_TOKEN`s for you with the GitHub API. You can create a token at [https://github.com/settings/tokens](https://github.com/settings/tokens). When you want the runners to work with public repos only, choose the `public_repo` scope, otherwise choose the `repo` scope. Always remember to keep the token and your runner config private!\n2. You can get a new `RUNNER_TOKEN` at [https://github.com/organizations/my-org/settings/actions/add-new-runner](https://github.com/organizations/my-org/settings/actions/add-new-runner). Note that you only have to copy the token used for `./config.sh`.\n\nYou can then start with\n```bash\nGO111MODULE=on go get -u github.com/romnnn/github-actions-runner-launcher/cmd/github-actions-runner-launcher\n# To install the runners dependencies, the first run needs sudo privileges\nsudo github-actions-runner-launcher --config sample.yml install\ngithub-actions-runner-launcher --config sample.yml run\n```\n\nYou can also download pre built binaries from the [releases page](https://github.com/romnnn/github-actions-runner-launcher/releases), or use the `docker` image:\n\n```bash\ndocker pull romnn/github-actions-runner-launcher\n```\n\nFor a list of options, run with `--help`.\n\n#### Troubleshooting\n\n- `Failed to prepare runner: Failed to install runner dependencies: fork/exec` usually indicates that you should run the script as a binary instead of with `go run`.\n\n#### Development\n\n######  Prerequisites\n\nBefore you get started, make sure you have installed the following tools::\n\n    $ python3 -m pip install -U cookiecutter\u003e=1.4.0\n    $ python3 -m pip install pre-commit bump2version invoke ruamel.yaml halo\n    $ go get -u golang.org/x/tools/cmd/goimports\n    $ go get -u golang.org/x/lint/golint\n    $ go get -u github.com/fzipp/gocyclo\n    $ go get -u github.com/mitchellh/gox  # if you want to test building on different architectures\n\n**Remember**: To be able to excecute the tools downloaded with `go get`, \nmake sure to include `$GOPATH/bin` in your `$PATH`.\nIf `echo $GOPATH` does not give you a path make sure to run\n(`export GOPATH=\"$HOME/go\"` to set it). In order for your changes to persist, \ndo not forget to add these to your shells `.bashrc`.\n\nWith the tools in place, it is strongly advised to install the git commit hooks to make sure checks are passing in CI:\n```bash\ninvoke install-hooks\n```\n\nYou can check if all checks pass at any time:\n```bash\ninvoke pre-commit\n```\n\nNote for Maintainers: After merging changes, tag your commits with a new version and push to GitHub to create a release:\n```bash\nbump2version (major | minor | patch)\ngit push --follow-tags\n```\n\n#### Note\n\nThis project is still in the alpha stage and should not be considered production ready.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromnn%2Fgithub-actions-runner-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromnn%2Fgithub-actions-runner-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromnn%2Fgithub-actions-runner-launcher/lists"}