cerc-io/act_runner
16
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add quickstart to readme

Browse Source
This commit is contained in:
Jason Song 2022-11-24 16:34:29 +08:00
parent b3e7d6a62d
commit 03c4c4e116
No known key found for this signature in database
GPG Key ID: 8402EEEE4511A8B5
1 changed files with 40 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -2,14 +2,46 @@
Act runner is a runner for Forges supports Github Actions protocol.
## Rigister
## Quickstart
create a new file as name `.env`
### build
```sh
GITEA_RUNNER_NAME=
GITEA_RPC_PROTO=http
GITEA_RPC_HOST=localhost:3001
GITEA_RUNNER_TOKEN=1234567890abcde
GITEA_RUNNER_LABELS=foo,bar
```shell
make build
```
### register
```shell
./act_runner register
```
And you will be asked to input:
1. Gitea instance URL, like `http://localhost:3000/`;
2. Runner token, you can get it from `http://localhost:3000/admin/runners`;
3. Runner name, you can just leave it blank;
4. Runner labels, you can just leave it blank.
The process looks like:
```text
INFO Registering runner, arch=amd64, os=darwin, version=0.1.5.
WARN Runner in user-mode.
INFO Enter the Gitea instance URL (for example, https://gitea.com/):
http://localhost:3000/
INFO Enter the runner token:
fe884e8027dc292970d4e0303fe82b14xxxxxxxx
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 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].
DEBU Successfully pinged the Gitea instance server
INFO Runner registered successfully.
```
### run
```shell
./act_runner daemon
```