Skip to content

Commit 5c3f0f5

Browse files
committed
docs: improve token permissions documentation and fix mermaid diagram
1 parent e353bb2 commit 5c3f0f5

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Runners are **ephemeral** — each container handles exactly one job and is remo
1313

1414
```mermaid
1515
flowchart LR
16-
A["GitHub Actions\n(job queue)"] -- long poll --> B["runscaler\n(this tool)"]
17-
B -- Docker API --> C["Runner Containers\n(ephemeral)"]
16+
A["GitHub Actions<br/>(job queue)"] -- long poll --> B["runscaler<br/>(this tool)"]
17+
B -- Docker API --> C["Runner Containers<br/>(ephemeral)"]
1818
```
1919

2020
1. Registers a [runner scale set](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller) with GitHub
@@ -39,7 +39,14 @@ flowchart LR
3939
### Prerequisites
4040

4141
- Docker running on the host
42-
- A GitHub **Personal Access Token** with `admin:org` scope (for org runners) or `repo` scope (for repo runners)
42+
- A GitHub **Personal Access Token** — required scopes depend on token type and runner level:
43+
44+
| Token type | Organization runners | Repository runners |
45+
|---|---|---|
46+
| **Classic PAT** | `admin:org` | `repo` |
47+
| **Fine-grained PAT** | Self-hosted runners: **Read and write** + Administration: **Read** | Administration: **Read and write** |
48+
49+
> **Note:** The token owner must be an **org owner** (for org runners) or have **admin access** to the repo (for repo runners). Fine-grained PATs targeting an organization may also require [admin approval](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization) depending on org policy.
4350
4451
### Install
4552

0 commit comments

Comments
 (0)