|
|
||
|---|---|---|
| .. | ||
| 2.332.0 | ||
| README.md | ||
| README_en.md | ||
| data.yml | ||
| logo.png | ||
README_en.md
Introduction
A simple self-hosted actions runner running in a container
Features
-
Supports Docker-out-of-Docker
-
Built-in github-cli python pip yq
Configuration and Usage Instructions
| Parameter | Required | Description |
|---|---|---|
ROLE |
Required | Used to differentiate between enterprise, organization, and personal repositories. Use enterprises for enterprise, orgs for organization, and repos for personal repositories.REST API |
REPO |
Required | Format for enterprise: enterpriseNameFormat for organization: orgNameFormat for personal repository: owner/repoREST API |
RUNNER_GITHUB_TOKEN |
Required | Fine-grained PAT is recommended. For enterprises: Fine-grained PAT cannot be used for enterprises OAuth app tokens and PAT (classic) require the manage_runners:enterprise permission.For organizations: Fine-grained PAT should have read and write permissions for Self-hosted runners. OAuth tokens and PAT (classic) require admin:org permissions,additionally, repo permissions are required for private organization repositories.For personal repositories: Fine-grained PAT should have read and write permissions for Administration. OAuth tokens and PAT (classic) require repo permissions.How to create a token? REST API |
RUNNER_NAME |
Runner name. If left empty, it will be randomly generated. Runner names must be unique within the same personal repository (or enterprise/organization). |
|
RUNNER_LABELS |
Runner labels. Filling this will add new labels.. Use commas to separate multiple labels. Example: label1,label2 |
|
WORK_FOLDER |
Working directory. If left empty, it will be randomly generated. Rarely needed. | |
RUNNER_GROUP |
Runner group. The default value is Default. For details, refer to the documentation. |
|
AUTO_UNREGISTER |
Whether to unregister the Runner from github.com when the container stops. Default is false. It is recommended to map /home/runner/.runner_config to a local when selecting false. This folder saves Runner's login status. |
For parameters marked with REST API, refer to the documentation.