diff --git a/README.md b/README.md index ae8ac236..29f2b270 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,33 @@ github-runner your-account/your-repo AARGHTHISISYOURGHACTIONSTOKEN github-runner your-account/some-other-repo ARGHANOTHERGITHUBACTIONSTOKEN ubuntu-xenial ``` +Or `docker-compose.yml`: +```yml +version: '2.3' + +services: + worker: + build: . + image: myoung34/github-runner:latest + environment: + REPO_URL: https://github.com/example/repo + RUNNER_NAME: example-name + RUNNER_TOKEN: someGithubTokenHere + RUNNER_WORKDIR: /tmp/runner/work + ORG_RUNNER: true + ORG_NAME: example-github-org + LABELS: linux,x64,gpu + security_opt: + # needed on SELinux systems to allow docker container to manage other docker containers + - label:disable + volumes: + - '/var/run/docker.sock:/var/run/docker.sock' + - '/tmp/runner:/tmp/runner' + # note: a quirk of docker-in-docker is that this path + # needs to be the same path on host and inside the container, + # docker mgmt cmds run outside of docker but expect the paths from within +``` + ### Nomad ### ```