https://github.com/defstudio/docker-github-runner
https://github.com/defstudio/docker-github-runner
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/defstudio/docker-github-runner
- Owner: defstudio
- Created: 2021-12-01T11:57:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-01T22:25:40.000Z (over 4 years ago)
- Last Synced: 2024-12-28T03:29:09.416Z (over 1 year ago)
- Language: Dockerfile
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Docker github runner
A docker image optimized for running [shivammathur/setup-php](https://github.com/shivammathur/setup-php) actions in a docker self-hosted runner, but not limited to it. Custom docker images and services can be handled in the workflow as well
### docker image
https://hub.docker.com/r/defstudio/github-runner
## Setup
- create a new `docker-compose.yml` file
```yml
version: '3.5'
services:
runner:
image: defstudio/github-runner:latest
restart: unless-stopped
environment:
ACCESS_TOKEN: "${ACCESS_TOKEN}"
RUNNER_NAME_PREFIX: "${RUNNER_NAME_PREFIX}"
ORG: "${ORG_NAME}"
LABELS: "${LABELS}"
security_opt:
- label:disable
volumes:
- '/var/run/docker.sock:/var/run/docker.sock'
```
- add an `.env` file to store settings
```dotenv
ACCESS_TOKEN=
RUNNER_NAME_PREFIX=runner
ORG_NAME=def-studio
LABELS=linux,self-hosted
```
## Starting new runners
#### Single runner
```shell
docker-compose up -d
```
#### Multiple runners
```shell
docker-compose up -d --scale runner=5
```
## Credits
- [Fabio Ivona](https://github.com/def-studio)
- [myoung34/docker-github-actions-runner](https://github.com/myoung34/docker-github-actions-runner)
- [https://github.com/shivammathur/setup-php](https://github.com/shivammathur/setup-php)
- [All Contributors](../../contributors)
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.