nprasad2077/runner
1
0 Fork 0
mirror of https://gitea.com/gitea/runner.git synced 2026-11-07 15:50:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation enhancements (#207)

Browse Source 
This PR addresses the issue listed in issue #170 regarding how to set up rootless Docker. It also expands on the documentation to show how to create deployments for different environments.

Co-authored-by: ccureau <[email protected]>
Reviewed-on: https://gitea.com/gitea/act_runner/pulls/207
Reviewed-by: Jason Song <[email protected]>
Co-authored-by: Chris Cureau <[email protected]>
Co-committed-by: Chris Cureau <[email protected]>
This commit is contained in:
Chris Cureauandccureau authored and Jason Song committed 2023-06-05 08:46:15 +00:00
1 parent e3271d8469
commit a384adbbc6
8 files changed
+225 -28
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+2 -28
View File
@@ -88,32 +88,6 @@ You can specify the configuration file path with `-c`/`--config` argument.
./act_runner -c config.yaml daemon # run with config file
```
### Run a docker container
### Example Deployments
```sh
docker run -e GITEA_INSTANCE_URL=http://192.168.8.18:3000 -e GITEA_RUNNER_REGISTRATION_TOKEN=<runner_token> -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/data:/data --name my_runner gitea/act_runner:nightly
```
The `/data` directory inside the docker container contains the runner API keys after registration.
It must be persisted, otherwise the runner would try to register again, using the same, now defunct registration token.
### Running in docker-compose
```yml
...
gitea:
image: gitea/gitea
...
runner:
image: gitea/act_runner
restart: always
depends_on:
- gitea
volumes:
- ./data/act_runner:/data
- /var/run/docker.sock:/var/run/docker.sock
environment:
- GITEA_INSTANCE_URL=<instance url>
- GITEA_RUNNER_REGISTRATION_TOKEN=<registration token>
```
Check out the [examples](examples) directory for sample deployment types.