https://github.com/binary-braids/github-actions-runner
GitHub Actions Runner configured using Dockerfile
https://github.com/binary-braids/github-actions-runner
docker github-actions github-actions-docker github-actions-runner
Last synced: 4 months ago
JSON representation
GitHub Actions Runner configured using Dockerfile
- Host: GitHub
- URL: https://github.com/binary-braids/github-actions-runner
- Owner: binary-braids
- License: mit
- Created: 2024-04-13T20:24:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-19T22:46:47.000Z (5 months ago)
- Last Synced: 2025-02-19T23:28:40.469Z (5 months ago)
- Topics: docker, github-actions, github-actions-docker, github-actions-runner
- Language: Shell
- Homepage:
- Size: 164 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.github.com/binary-braids)
# [binary-braids/github-actions-runner](https://github.com/binary-braids/github-actions-runner)
A self-hosted runner is a system that you deploy and manage to execute jobs from GitHub Actions on GitHub.com
[](http://hits.dwyl.com/binary-braids/github-actions-runner)
[](https://github.com/renovatebot/renovate)
[](https://trivy.dev)
[](https://www.github.com)
## Table of Contents
- [Configuration](#configuration)
- [Prerequisites](#prerequisites)
- [Required Environment Variables](#required-environment-variables)
- [Optional Environment Variables](#optional-environment-variables)
- [Available Architecture](#available-architecture)
- [Examples](#examples)
- [Docker Compose](#docker-compose)
- [Docker CLI](#docker-cli)
- [Support](#support)
- [Issues](#issues)
- [Feature Requests](#feature-requests)
- [Updates](#updates)
## Configuration
### Prerequisites
You will need to generate a GitHub Personal Access Token to use with the container image. This will allow the runner to register with your specified organization.
To generate a token follow this guide: [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
>[!NOTE]
> You will need to grant the `Read and write` permissions under `Self-hosted runners` for Fine-grained tokens or `manage_runners:org` permissions for classic tokens
### Required Environment Variables
| Variable | Description |
| ---- | --- |
| ORGANIZATION | The GitHub Organization Name |
| ACCESS_TOKEN | The Access Token to allow the runner to register to the organization. |
### Optional Environment Variables
| Variable | Description |
| ---- | --- |
| USE_HOSTNAME | If set to `TRUE` then the container name will be used as the runner name. Defaults to `FALSE` |
| CUSTOM_NAME | Use this option to configure a custom name for the runner |
## Available Architecture
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\ |
| arm64 | ✅ | arm64-\ |
## Examples
### Docker Compose
```yaml
services:
github-actions-runner:
image: ghcr.io/binary-braids/github-actions-runner:latest
container_name: github-actions-runner
environment:
- ORGANIZATION=
- ACCESS_TOKEN=
restart: unless-stopped
```
### Docker CLI
```bash
docker run -d \
--name=github-actions-runner \
--e ORGANIZATION= \
--e ACCESS_TOKEN= \
ghcr.io/binary-braids/github-actions-runner:latest
```
## Support
This image is provided as is and is a hobby project. With that being said, please see below on details for support.
### Issues
- Please submit a new [Issue](https://github.com/binary-braids/github-actions-runner/issues/new) if you encounter any bugs or issues
### Feature Requests
- You are welcome to submit a feature request but no timeline or guarantee will be provided regarding implentation thereof
### Updates
- The image will be updated from time to time based on fixes or new features