summaryrefslogtreecommitdiffstats
path: root/examples/docker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/docker/README.md')
-rw-r--r--examples/docker/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/docker/README.md b/examples/docker/README.md
new file mode 100644
index 0000000..628c99c
--- /dev/null
+++ b/examples/docker/README.md
@@ -0,0 +1,12 @@
+The following assumes:
+
+* a docker server runs on the host
+* the docker group of the host is GID 133
+* a `.runner` file exists in /tmp/data
+* a `runner-config.yml` file exists in /tmp/data
+
+```sh
+docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/data:/data --user 1000:133 --rm code.forgejo.org/forgejo/runner:3.0.0 forgejo-runner --config runner-config.yaml daemon
+```
+
+The workflows will run using the host docker srever