Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 11 days 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 (7 months ago)
Default Branch: main
Last Pushed: 2024-11-08T18:10:33.000Z (12 days ago)
Last Synced: 2024-11-08T19:23:03.862Z (12 days ago)
Topics: docker, github-actions, github-actions-docker, github-actions-runner
Language: Shell
Homepage:
Size: 116 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![binary-braids](./src/img/binary-braids-logo.png)](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

![GitHub Actions](https://github.com/binary-braids/github_actions_runner/actions/workflows/main.yml/badge.svg)

[![HitCount](https://hits.dwyl.com/binary-braids/github-actions-runner.svg?style=for-the-badge&show=unique)](http://hits.dwyl.com/binary-braids/github-actions-runner)

[![renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?style=for-the-badge&logo=renovatebot)](https://github.com/renovatebot/renovate)

[![Trivy](https://img.shields.io/badge/trivy-enabled-brightgreen?style=for-the-badge&logo=trivy)](https://trivy.dev)

[![github](./src/img/github-mark.png)](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