1
0
Fork 0
1Panel-Appstore/apps/forgejo-runner/README.md

23 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 产品介绍
Forgejo Runner 是一个守护进程,用于连接到 Forgejo 实例并运行持续集成 (CI) 作业。该项目是 Forgejo 生态系统的一部分,旨在为 Forgejo 用户提供类似 GitHub Actions 的自动化工作流能力。其核心价值在于为自托管的 Forgejo 实例提供原生的 CI/CD 功能,目标用户是需要自动化构建、测试和部署流程的开发团队和组织,特别是在需要自托管解决方案的场景中。
## 主要功能
- **持续集成作业执行**: 作为守护进程连接到 Forgejo 实例,自动拉取并执行工作流中定义的 CI/CD 任务,支持开发者实现自动化构建、测试和部署流程。
- **多架构支持**: 目前正式支持在基于 Linux 内核的操作系统上运行,涵盖 `amd64``arm64` 架构,并提供二进制文件和容器镜像,同时正在积极开发对其他架构 (如 s390x、powerpc64le、riscv64 和 Windows) 的支持。
- **与 Forgejo 深度集成**: 作为 Forgejo 的原生 Actions 运行器,能够无缝集成到 Forgejo 的工作流系统中,用户可以通过 Forgejo 界面配置和管理自动化任务。
## 配置和使用说明
- **选择版本**: 现提供两种版本,常规版本 (下称 DooD 版本) 与 DinD 版本。
- DooD 版权限更高,与宿主机共享 docker 环境遇到需要在工作流中使用容器的情况DooD 版本可以在宿主机管理 Runner 中的容器;
- DinD 版安全性更强docker 环境与宿主机完全独立,基本没有越权;
- 当 DinD 版本下运行某些 action 权限不足时,请先尝试启用特权模式,若仍报错,再尝试使用 DooD 版。
- **Forgejo 实例 URL**: (例如 `https://git.example.com`)
- **注册令牌**: 从 Create new runner 按钮中获取,仅用于 Runner 实例,需要区别于个人访问令牌 (PAT)
- **运行器名称**: 区分不同 Runner 实例的唯一标识符,同一命名空间 (仓库或组织) 下不允许重复
- **运行器标签**: 用于标记 Runner 实例,工作流中可以根据标签选择 Runner 执行任务,同一个标签可以绑定多个 Runner 实例