https://github.com/rolehippie/github-runner
Ansible role to install and configure a GitHub self-hosted runner
https://github.com/rolehippie/github-runner
ansible ansible-role hacktoberfest role
Last synced: 6 months ago
JSON representation
Ansible role to install and configure a GitHub self-hosted runner
- Host: GitHub
- URL: https://github.com/rolehippie/github-runner
- Owner: rolehippie
- License: apache-2.0
- Created: 2023-09-14T14:27:22.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-01-10T10:27:57.000Z (6 months ago)
- Last Synced: 2026-01-11T03:23:10.843Z (6 months ago)
- Topics: ansible, ansible-role, hacktoberfest, role
- Language: Nix
- Size: 206 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# github-runner
[](https://github.com/rolehippie/github-runner)
[](https://github.com/rolehippie/github-runner/actions/workflows/general.yml)
[](https://github.com/rolehippie/github-runner/actions/workflows/docs.yml)
[](https://github.com/rolehippie/github-runner/actions/workflows/galaxy.yml)
[](https://github.com/rolehippie/github-runner/blob/master/LICENSE)
[](https://galaxy.ansible.com/rolehippie/github-runner)
Ansible role to install and configure a GitHub self-hosted runner.
## Sponsor
Building and improving this Ansible role have been sponsored by my current and previous employers like **[Cloudpunks GmbH](https://cloudpunks.de)** and **[Proact Deutschland GmbH](https://www.proact.eu)**.
## Table of contents
- [Requirements](#requirements)
- [Default Variables](#default-variables)
- [github_runner_api](#github_runner_api)
- [github_runner_arch](#github_runner_arch)
- [github_runner_args](#github_runner_args)
- [github_runner_as_root](#github_runner_as_root)
- [github_runner_dir](#github_runner_dir)
- [github_runner_download](#github_runner_download)
- [github_runner_enterprise](#github_runner_enterprise)
- [github_runner_envvars](#github_runner_envvars)
- [github_runner_group](#github_runner_group)
- [github_runner_groups](#github_runner_groups)
- [github_runner_hide_sensitive_logs](#github_runner_hide_sensitive_logs)
- [github_runner_labels](#github_runner_labels)
- [github_runner_name](#github_runner_name)
- [github_runner_org](#github_runner_org)
- [github_runner_reinstall](#github_runner_reinstall)
- [github_runner_repo](#github_runner_repo)
- [github_runner_state](#github_runner_state)
- [github_runner_system](#github_runner_system)
- [github_runner_token](#github_runner_token)
- [github_runner_url](#github_runner_url)
- [github_runner_user](#github_runner_user)
- [github_runner_version](#github_runner_version)
- [runner_runner_grouping](#runner_runner_grouping)
- [Discovered Tags](#discovered-tags)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)
---
## Requirements
- Minimum Ansible version: `2.10`
## Default Variables
### github_runner_api
API URL to access GitHub
#### Default value
```YAML
github_runner_api: https://api.github.com
```
### github_runner_arch
Architecture of the system
#### Default value
```YAML
github_runner_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'x64' }}"
```
### github_runner_args
Optional arguments for the runner
#### Default value
```YAML
github_runner_args:
```
### github_runner_as_root
Install service as root
#### Default value
```YAML
github_runner_as_root: false
```
### github_runner_dir
Home and working path
#### Default value
```YAML
github_runner_dir: /home/runner
```
### github_runner_download
URL to download the runner from
#### Default value
```YAML
github_runner_download: https://github.com/actions/runner/releases/download/v{{
github_runner_version }}/actions-runner-{{ github_runner_system }}-{{
github_runner_arch }}-{{ github_runner_version }}.tar.gz
```
### github_runner_enterprise
Enterprise to register the runner
#### Default value
```YAML
github_runner_enterprise:
```
### github_runner_envvars
Additional env variables injected into .env
#### Default value
```YAML
github_runner_envvars:
```
### github_runner_group
Group user for the runner processes
#### Default value
```YAML
github_runner_group: runner
```
### github_runner_groups
Additional groups for the runner
#### Default value
```YAML
github_runner_groups:
- sudo
- docker
```
### github_runner_hide_sensitive_logs
Hide potentially sensitive logs
#### Default value
```YAML
github_runner_hide_sensitive_logs: false
```
### github_runner_labels
Labels for the runner
#### Default value
```YAML
github_runner_labels:
- self-hosted
```
### github_runner_name
Name of the runner
#### Default value
```YAML
github_runner_name: '{{ ansible_hostname }}'
```
### github_runner_org
Organization to register the runner
#### Default value
```YAML
github_runner_org:
```
### github_runner_reinstall
Always reinstall the service
#### Default value
```YAML
github_runner_reinstall: false
```
### github_runner_repo
Repo to register the runner
#### Default value
```YAML
github_runner_repo:
```
### github_runner_state
State of the runner service
#### Default value
```YAML
github_runner_state: started
```
### github_runner_system
Operating system for the runner
#### Default value
```YAML
github_runner_system: "{{ 'osx' if ansible_system == 'Darwin' else 'linux' }}"
```
### github_runner_token
Personal access token for runner registration token retrieval
#### Default value
```YAML
github_runner_token:
```
### github_runner_url
General URL to access GitHub
#### Default value
```YAML
github_runner_url: https://github.com
```
### github_runner_user
User used for the runner processes
#### Default value
```YAML
github_runner_user: runner
```
### github_runner_version
Version fo the runner
#### Default value
```YAML
github_runner_version: 2.331.0
```
### runner_runner_grouping
Optional group name for the runner
#### Default value
```YAML
runner_runner_grouping:
```
## Discovered Tags
**_github-runner_**
## Dependencies
- None
## License
Apache-2.0
## Author
[Thomas Boerger](https://github.com/tboerger)