tcardonne/github-runner

GitHub Runner

GitHub允许开发者使用自托管运行器执行Actions工作流，本镜像提供在Docker中创建自托管运行器的能力，目前支持Debian Buster（latest标签）和Ubuntu Focal（ubuntu-20.04标签）版本。

重要注意事项

• GitHub建议不要在公共仓库使用自托管运行器（安全原因）；
• 组织级运行器支持，但相关API处于公测阶段，可能变动。

使用场景

适用于需要自定义Actions运行环境、控制资源或在私有网络执行工作流的开发者与团队。

配置说明与部署示例

基础用法

启动运行器监听任务：

shell
docker run -it --name my-runner \
    -e RUNNER_NAME=my-runner \
    -e GITHUB_ACCESS_TOKEN=你的令牌 \
    -e RUNNER_REPOSITORY_URL=https://github.com/你的仓库地址 \
    tcardonne/github-runner

运行器内使用Docker

若需在工作流中构建镜像，绑定主机Docker套接字：

shell
docker run -it --name my-runner \
    -e RUNNER_NAME=my-runner \
    -e GITHUB_ACCESS_TOKEN=你的令牌 \
    -e RUNNER_REPOSITORY_URL=https://github.com/你的仓库地址 \
    -v /var/run/docker.sock:/var/run/docker.sock \
    tcardonne/github-runner

Docker Compose配置

docker-compose.yml：

yaml
version: "3.7"
services:
    runner:
      image: tcardonne/github-runner:latest
      environment:
        RUNNER_NAME: "my-runner"
        RUNNER_REPOSITORY_URL: ${RUNNER_REPOSITORY_URL}
        # RUNNER_ORGANIZATION_URL: ${RUNNER_ORGANIZATION_URL}
        GITHUB_ACCESS_TOKEN: ${GITHUB_ACCESS_TOKEN}
      volumes:
        - /var/run/docker.sock:/var/run/docker.sock

创建.env文件：

RUNNER_REPOSITORY_URL=https://github.com/你的仓库地址
# RUNNER_ORGANIZATION_URL=https://github.com/你的组织名
GITHUB_ACCESS_TOKEN=你的令牌

环境变量

运行器令牌获取

1. 推荐方式：使用个人访问令牌（PAT），仓库级需repo权限，组织级需admin:org权限；
2. 临时方式：在仓库/组织Actions设置页的“添加运行器”中获取RUNNER_TOKEN。

自动更新

运行器二进制文件会在接收任务时自动更新，由supervisord进程管理重启。