Skip to content

Commit 0847c0e

Browse files
committed
Rewrite readme
1 parent 7b0cabe commit 0847c0e

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub Actions Runner
22

3-
Built on `ubuntu:20.04`, configured for rootless dind 🎉, impossible without valuable advice from @kenichi-shibata and @sidick and work by @myoung34.
3+
Built on `ubuntu:20.04`, configured for rootless dind 🎉, impossible without invaluable advice from @kenichi-shibata and @sidick and work by @msyea.
44
## Inspiration from
55
* https://github.com/cruizba/ubuntu-dind showed me it was possible on ubuntu
66
* https://github.com/myoung34/docker-github-actions-runner showed it running docker outside docker - inspired API and wrote some README - rights theirs
@@ -27,18 +27,12 @@ This will run the [new self-hosted github actions runners](https://help.github.c
2727
| `ORG_RUNNER` | Only valid if using `ACCESS_TOKEN`. This will set the runner to an org runner. Default is 'false'. Valid values are 'true' or 'false'. If this is set to true you must also set `ORG_NAME` and makes `REPO_URL` unneccesary |
2828
| `ORG_NAME` | The organization name for the runner to register under. Requires `ORG_RUNNER` to be 'true'. No default value. |
2929
| `LABELS` | A comma separated string to indicate the labels. Default is 'default' |
30-
| `REPO_URL` | If using a non-organization runner this is the full repository url to register under such as 'https://github.com/myoung34/repo' |
30+
| `REPO_URL` | If using a non-organization runner this is the full repository url to register under such as 'https://github.com/msyea/repo' |
3131
| `RUNNER_TOKEN` | If not using a PAT for `ACCESS_TOKEN` this will be the runner token provided by the Add Runner UI (a manual process). Note: This token is short lived and will change frequently. `ACCESS_TOKEN` is likely preferred. |
3232
| `RUNNER_WORKDIR` | The working directory for the runner. Runners on the same host should not share this directory. Default is '/_work'. This must match the source path for the bind-mounted volume at RUNNER_WORKDIR, in order for container actions to access files. |
3333
| `RUNNER_GROUP` | Name of the runner group to add this runner to (defaults to the default runner group) |
3434
| `GITHUB_HOST` | Optional URL of the Github Enterprise server e.g github.mycompany.com. Defaults to `github.com`. |
3535

36-
## Examples ##
37-
38-
### Note ###
39-
40-
If you're using a RHEL based OS with SELinux, add `--security-opt=label=disable` to prevent [permission denied](https://github.com/myoung34/docker-github-actions-runner/issues/9)
41-
4236
### Manual ###
4337

4438
```shell
@@ -54,7 +48,7 @@ docker run -d --restart always --name github-runner \
5448
msyea/github-actions-runner:latest
5549
# per repo
5650
docker run -d --restart always --name github-runner \
57-
-e REPO_URL="https://github.com/myoung34/repo" \
51+
-e REPO_URL="https://github.com/msyea/repo" \
5852
-e RUNNER_NAME="foo-runner" \
5953
-e RUNNER_TOKEN="footoken" \
6054
-e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \

0 commit comments

Comments
 (0)