Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/emberstack/docker-github-actions-runner

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/emberstack/docker-github-actions-runner
Owner: emberstack
License: mit
Created: 2023-12-24T14:33:01.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-26T12:43:00.000Z (9 months ago)
Last Synced: 2024-04-26T13:46:57.430Z (9 months ago)
Language: Shell
Size: 13.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # GitHub Self-Hosted Runner for Docker

[![Pipeline](

[GitHub Self-Hosted Runner for Docker](https://github.com/emberstack/docker-github-actions-runner) is self-hosted agent that you can run in a container with Docker.

[![Pipeline](https://github.com/emberstack/docker-github-actions-runner/actions/workflows/pipeline.yaml/badge.svg)](https://github.com/emberstack/docker-github-actions-runner/actions/workflows/pipeline.yaml)

[![Release](https://img.shields.io/github/release/emberstack/docker-github-actions-runner.svg?style=flat-square)](https://github.com/emberstack/docker-github-actions-runner/releases/latest)

[![Docker Image](https://img.shields.io/docker/image-size/emberstack/github-actions-runner/latest?style=flat-square)](https://hub.docker.com/r/emberstack/github-actions-runner)

[![Docker Pulls](https://img.shields.io/docker/pulls/emberstack/github-actions-runner.svg?style=flat-square)](https://hub.docker.com/r/emberstack/github-actions-runner)

[![license](https://img.shields.io/github/license/emberstack/docker-github-actions-runner.svg?style=flat-square)](LICENSE)

> Supports `amd64`, `arm` and `arm64`

## Runner Version

This image will automatically pull and install the latest runner version at startup.

### Support

If you need help or found a bug, please feel free to open an issue on the [emberstack/docker-github-actions-runner](https://github.com/emberstack/docker-github-actions-runner) GitHub project.  

## Deployment

The runner can be deployed in Docker using either `docker run` or `docker compose`.

#### Deployment in `docker`

```

docker run -d -e ACCESS_TOKEN="" -e ORGANIZATION="" -e REPO="" emberstack/github-actions-runner

```

> See [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) to understand how to get an access token. 

You can customize the values of the deployment by using the following environment variables:

| Environment Variable          | Description                                                                                       | Required                                                 |

|-------------------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------|

| `ACCESS_TOKEN`                | The access token (PAT - Personal Access token) used to register the runner                        | Required                                                 |

| `ORGANIZATION`                | The owner or organization                                                                         | Required                                                 |

| `REPO`                        | The repository on which to register the runner                                                    | Optional - Registers to the org. if not specified        |

| `LABELS`                      | Comma separated list of labels to apply to the runner                                             | Optional                                                 |

| `NAME`                        | Runner name                                                                                       | Optional - Defaults to the hostname if not specified     |