63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
# Gitea Runner 配置说明
|
||
|
||
## 项目简介
|
||
|
||
这是一个用于配置和运行 Gitea Runner 的 Docker Compose 项目。Gitea Runner 是 Gitea 的 CI/CD 执行器，用于运行 Gitea Actions 工作流程，runner不够用时，可以在公司电脑本地部署，提高效率。
|
||
|
||
## 配置说明
|
||
|
||
### 必要配置项
|
||
|
||
在使用之前，需要修改 `docker-compose.yml` 中的以下配置项：
|
||
|
||
1. `GITEA_RUNNER_REGISTRATION_TOKEN`：
|
||
- 这是您的 Gitea 账号的 registration token
|
||
- 获取方法：
|
||
1. 登录您的 Gitea 实例
|
||
2. 进入设置页面
|
||
3. 在左侧菜单找到 Actions
|
||
4. 点击「创建 Runner」获取 token
|
||
|
||
2. `GITEA_RUNNER_NAME`：
|
||
- 设置 Runner 的名称
|
||
- 建议使用有意义的名称，方便识别（如：team-dev-runner）
|
||
|
||
### 其他重要配置
|
||
|
||
- `GITEA_INSTANCE_URL`：Gitea 实例的 URL
|
||
- `DOCKER_HOST`：Docker 套接字路径，用于 Docker in Docker 功能
|
||
- 端口映射：9010 端口用于 Actions 缓存服务
|
||
|
||
## 使用方法
|
||
|
||
1. 克隆此项目到本地
|
||
2. 修改上述必要配置项
|
||
3. 在项目目录下运行：
|
||
```bash
|
||
docker-compose up -d
|
||
```
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
./
|
||
├── config.yaml # Runner 详细配置文件
|
||
├── docker-compose.yml # Docker 编排配置文件
|
||
└── data/ # Runner 数据目录
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
1. Runner 需要特权模式运行，因为需要支持 Docker in Docker 功能
|
||
2. 确保 Docker 套接字正确挂载
|
||
3. 首次启动时会自动注册 Runner 到您的 Gitea 实例
|
||
4. 默认支持 ubuntu-latest 等多个运行环境
|
||
|
||
## 支持的运行环境
|
||
|
||
默认支持以下运行环境：
|
||
- ubuntu-latest
|
||
- ubuntu-22.04
|
||
- ubuntu-20.04
|
||
|
||
可以在 `config.yaml` 中根据需要添加或修改支持的环境。 |