From 46cd5ef96ceb7b23fb82ecab5829118a97ae215d Mon Sep 17 00:00:00 2001 From: Mehrdad Date: Wed, 8 Jul 2026 15:11:38 +0300 Subject: [PATCH] update --- README.md | 52 +++++++++++++++++++++++++--------------------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index be4476f..56fff80 100644 --- a/README.md +++ b/README.md @@ -57,39 +57,35 @@ services: Replace `myorg` with your org name and paste your token into `ACCESS_TOKEN`. -### 4. Start the runner +> **Important:** `RUNNER_GROUP` must be `self-hosted`. The GitHub runner group +> name must match this value exactly (see step 4). + +### 4. Create the runner group (name must be `self-hosted`) + +The group **name must be exactly `self-hosted`** — it has to match +`RUNNER_GROUP: self-hosted` in `docker-compose.yml`. Any other name will fail +registration. + +1. Go to **https://github.com/organizations/myorg/settings/actions/runner-groups**. +2. Create a new group and set **Group name** to `self-hosted` (exact spelling). +3. **Repository access:** select **Selected repositories**, then choose which repos may use this runner. +4. Optionally enable **Allow public repositories** if you need runners on public repos (security risk — read GitHub’s warning first). +5. **Workflow access:** select **All workflows** (or restrict to specific workflows if you prefer). + +> Replace `myorg` in the URL above with your actual org name. + +### 5. Start the runner ```bash docker compose up -d ``` -Check it's connected under **GitHub → Org → Settings → Actions → Runners**, then 💥 you're done. +With `RUNNER_GROUP: self-hosted` set, the runner registers into that group +automatically. Confirm it under **GitHub → Org → Settings → Actions → Runners** +(and under **Runner groups → self-hosted**). -## 5. Put the runner in a group - -Once the runner shows up, group it so you can control which repos can use it. - -### Create the group - -1. Go to **https://github.com/organizations/myorg/settings/actions/runner-groups**. -2. Create a new group named `self-hosted`. -3. **Repository access:** select **Selected repositories**. -4. Check **Allow public repositories** -5. **Workflow access:** select **All workflows**. - -### Move the runner into the group - -1. Go to **https://github.com/organizations/myorg/settings/actions/runners**. -2. Find your new runner and click it. -3. In the **Runner group** section, move it into `self-hosted` - -### Assign repositories to the group - -Go back to **https://github.com/organizations/myorg/settings/actions/runner-groups**, -open the `self-hosted` group, and use the **Selected repositories** ⚙️ (cog) button to -add the repositories that are allowed to use this runner. - -> Replace `myorg` in the URLs above with your actual org name. +If it landed in the Default group instead, open the runner and move it into +`self-hosted`. ## Useful commands @@ -107,6 +103,8 @@ create that folder with `mkdir -p data/`. ## Notes +- The runner group **must** be named `self-hosted` so it matches + `RUNNER_GROUP: self-hosted` in `docker-compose.yml`. - The default image is mirrored to `git.neo24.net/public/github-action-runner:latest`. To re-mirror the upstream image (see `cmd-to-push.txt`):