snowykami
a28f5b551e
All checks were successful
release-nightly / release-image (push) Successful in 15m20s
145 lines
4.5 KiB
Markdown
145 lines
4.5 KiB
Markdown
# Liteyuki Runner
|
||
|
||
## 需求
|
||
如果你的Gitea实例偏公共性质，又不想让所有人都能使用Actions，
|
||
且有多个组织/用户，又不想配置多个Runner给每个仓库和组织分配一个
|
||
|
||
那么这个项目应该可以满足你的需求
|
||
|
||
遵循源项目许可证进行二次分发
|
||
|
||
## 特色
|
||
```yaml
|
||
# 仅需要在原有的配置文件 runner项下添加一个allowed_repos: []string的配置项目
|
||
# 配置非常简单，owner/repo格式。*表示所有repo或者owner
|
||
runner:
|
||
allowed_repos:
|
||
- "org1/repo1" # 仅允许org1/repo1使用
|
||
- "org1/repo2" # 仅允许org1/repo2使用
|
||
- "org2/*" # 仅允许org2下的所有repo使用
|
||
- "user1/*" # 仅允许user1下的所有repo使用
|
||
blacklist_mode: false # 是否启用黑名单模式，启用后为反向选择
|
||
reject_text: "This repository {REPO} is not allowed to use this runner {RUNNER} to run workflows." # 禁止使用actions时的提示文本
|
||
```
|
||
|
||
## 安装
|
||
- (安装方法和Gitea Runner相同，只是镜像换成了我们的)
|
||
|
||
```bash
|
||
docker pull reg.liteyuki.icu/actions/liteyuki-runner:latest
|
||
|
||
podman pull reg.liteyuki.icu/actions/liteyuki-runner:latest
|
||
```
|
||
|
||
|
||
> 下面是Gitea Runner官方文档
|
||
|
||
# act runner
|
||
|
||
Act runner is a runner for Gitea based on [Gitea fork](https://gitea.com/gitea/act) of [act](https://github.com/nektos/act).
|
||
|
||
## Installation
|
||
|
||
### Prerequisites
|
||
|
||
Docker Engine Community version is required for docker mode. To install Docker CE, follow the official [install instructions](https://docs.docker.com/engine/install/).
|
||
|
||
### Download pre-built binary
|
||
|
||
Visit [here](https://dl.gitea.com/act_runner/) and download the right version for your platform.
|
||
|
||
### Build from source
|
||
|
||
```bash
|
||
make build
|
||
```
|
||
|
||
### Build a docker image
|
||
|
||
```bash
|
||
make docker
|
||
```
|
||
|
||
## Quickstart
|
||
|
||
Actions are disabled by default, so you need to add the following to the configuration file of your Gitea instance to enable it:
|
||
|
||
```ini
|
||
[actions]
|
||
ENABLED=true
|
||
```
|
||
|
||
### Register
|
||
|
||
```bash
|
||
./act_runner register
|
||
```
|
||
|
||
And you will be asked to input:
|
||
|
||
1. Gitea instance URL, like `http://192.168.8.8:3000/`. You should use your gitea instance ROOT_URL as the instance argument
|
||
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/actions/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://192.168.8.8: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-latest:docker://docker.gitea.com/runner-images:ubuntu-latest):
|
||
|
||
INFO Registering runner, name=Test.local, instance=http://192.168.8.8:3000/, labels=[ubuntu-latest:docker://docker.gitea.com/runner-images:ubuntu-latest ubuntu-22.04:docker://docker.gitea.com/runner-images:ubuntu-22.04 ubuntu-20.04:docker://docker.gitea.com/runner-images:ubuntu-20.04].
|
||
DEBU Successfully pinged the Gitea instance server
|
||
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
|
||
|
||
```bash
|
||
./act_runner daemon
|
||
```
|
||
|
||
### Run with docker
|
||
|
||
```bash
|
||
docker run -e GITEA_INSTANCE_URL=https://your_gitea.com -e GITEA_RUNNER_REGISTRATION_TOKEN=<your_token> -v /var/run/docker.sock:/var/run/docker.sock --name my_runner gitea/act_runner:nightly
|
||
```
|
||
|
||
### Configuration
|
||
|
||
You can also configure the runner with a configuration file.
|
||
The configuration file is a YAML file, you can generate a sample configuration file with `./act_runner generate-config`.
|
||
|
||
```bash
|
||
./act_runner generate-config > config.yaml
|
||
```
|
||
|
||
You can specify the configuration file path with `-c`/`--config` argument.
|
||
|
||
```bash
|
||
./act_runner -c config.yaml register # register with config file
|
||
./act_runner -c config.yaml daemon # run with config file
|
||
```
|
||
|
||
You can read the latest version of the configuration file online at [config.example.yaml](internal/pkg/config/config.example.yaml).
|
||
|
||
### Example Deployments
|
||
|
||
Check out the [examples](examples) directory for sample deployment types.
|