https://github.com/kuju63/github-runner
Container image for GitHub Actions self hosted runner.
https://github.com/kuju63/github-runner
docker-image github-runner runner
Last synced: 24 days ago
JSON representation
Container image for GitHub Actions self hosted runner.
- Host: GitHub
- URL: https://github.com/kuju63/github-runner
- Owner: kuju63
- License: mit
- Created: 2021-04-11T11:42:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T23:33:52.000Z (over 1 year ago)
- Last Synced: 2024-08-21T01:15:14.945Z (over 1 year ago)
- Topics: docker-image, github-runner, runner
- Language: Shell
- Homepage: https://hub.docker.com/r/jkurihara/github-runner
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-runner
github-runner is self hosted runner for GitHub. This is working on container.
## How to use
```bash
docker run -d --rm --name runner \
-e token="Your runner token" \
-e owner="repository owner" \
-e repo_name="repository name" \
-e runner_name="Runner name" \
-e label="label1,label2" \
github-runner:latest
```
If need to set proxy settings, set environment variables of proxy. See [GitHub Docs](https://docs.github.com/ja/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners).
## Setting
### http_proxy / https_proxy
**Optional** This settings are proxy setting.
Set your proxy server url.
ex.
```bash
http://:@hostname:port-number
```
### runner_name
**Requirement** This is to set runner name.
### token
**Optional** This is to set self hosted runner token.
This token is generated by github.
**Warning** Token can't use when restart container, because it is expired.
### owner
**Requirement** This is to set runner owner, for example organization name or user name.
ex. kuju63
### repo_name
**Requirement** This is to set repository name. This image is not supported organization runner.
ex. github-runner
### label [Optional]
Labeled to Self-Hosted-runner. Details see [here](https://docs.github.com/en/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners).
### group [Optional]
Add runner to specified self-hosted runner group. Self-hosted runner group is using Organization only.
### tls_no_verify[Optional]
Disable verify process for SSL/TLS. When Proxy server using self-signed certificate, this option is need to set "1".
### disable_auto_update [Optional]
Opt-out auto-update to the latest runner version. Use this option, this is need to set "0".
actions/runner
Details see [GitHub Docs (Controlling runner software updates on self-hosted runners)](https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)