Update README about register

This commit is contained in:
Lunny Xiao 2022-11-25 00:40:00 +08:00
parent 474683c0e8
commit d1017d752f
No known key found for this signature in database
GPG Key ID: C3B7C91B632F738A
1 changed files with 14 additions and 5 deletions

View File

@ -1,6 +1,6 @@
# act runner # act runner
Act runner is a runner for Forges supports Github Actions protocol. Act runner is a runner for Gitea based on [act](https://gitea.com/gitea/act).
## Quickstart ## Quickstart
@ -18,8 +18,9 @@ make build
And you will be asked to input: And you will be asked to input:
1. Gitea instance URL, like `http://localhost:3000/`; 1. Gitea instance URL, like `http://192.168.8.8:3000/`. You should use your gitea instance ROOT_URL as the instance argument
2. Runner token, you can get it from `http://localhost:3000/admin/runners`; and you should not use `localhost` or `127.0.0.1` as instance IP;
2. Runner token, you can get it from `http://192.168.8.8:3000/admin/runners`;
3. Runner name, you can just leave it blank; 3. Runner name, you can just leave it blank;
4. Runner labels, you can just leave it blank. 4. Runner labels, you can just leave it blank.
@ -29,18 +30,26 @@ The process looks like:
INFO Registering runner, arch=amd64, os=darwin, version=0.1.5. INFO Registering runner, arch=amd64, os=darwin, version=0.1.5.
WARN Runner in user-mode. WARN Runner in user-mode.
INFO Enter the Gitea instance URL (for example, https://gitea.com/): INFO Enter the Gitea instance URL (for example, https://gitea.com/):
http://localhost:3000/ http://192.168.8.8:3000/
INFO Enter the runner token: INFO Enter the runner token:
fe884e8027dc292970d4e0303fe82b14xxxxxxxx fe884e8027dc292970d4e0303fe82b14xxxxxxxx
INFO Enter the runner name (if set empty, use hostname:Test.local ): INFO Enter the runner name (if set empty, use hostname:Test.local ):
INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-20.04:docker://node:16-bullseye,ubuntu-18.04:docker://node:16-buster): INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-20.04:docker://node:16-bullseye,ubuntu-18.04:docker://node:16-buster):
INFO Registering runner, name=Test.local, instance=http://localhost:3000/, labels=[ubuntu-latest:docker://node:16-bullseye ubuntu-22.04:docker://node:16-bullseye ubuntu-20.04:docker://node:16-bullseye ubuntu-18.04:docker://node:16-buster]. INFO Registering runner, name=Test.local, instance=http://192.168.8.8:3000/, labels=[ubuntu-latest:docker://node:16-bullseye ubuntu-22.04:docker://node:16-bullseye ubuntu-20.04:docker://node:16-bullseye ubuntu-18.04:docker://node:16-buster].
DEBU Successfully pinged the Gitea instance server DEBU Successfully pinged the Gitea instance server
INFO Runner registered successfully. INFO Runner registered successfully.
``` ```
You can also register with command line arguments.
```bash
./act_runner register --instance http://192.168.8.8:3000 --token <my_runner_token> --no-interactive
```
If the registry succeed, it will run immediately. Next time, you could run the runner directly.
### Run ### Run
```bash ```bash