Skip to content

docs: document the one-time broker elevation flow and accept fine-grained tokens#4

Draft
tomgrv wants to merge 1 commit into
mainfrom
claude/repo-code-review-pf6dsb
Draft

docs: document the one-time broker elevation flow and accept fine-grained tokens#4
tomgrv wants to merge 1 commit into
mainfrom
claude/repo-code-review-pf6dsb

Conversation

@tomgrv

@tomgrv tomgrv commented Jul 4, 2026

Copy link
Copy Markdown
Owner

What

Companion to tomgrv/synology-package-builder#12, which replaces the elevated mode with a least-privilege root broker.

  • README installation steps rewritten: the package now installs cleanly and stays stopped instead of going into an error state; the manual root step becomes a single reviewable sudo /var/packages/GithubRunner/scripts/elevate command that shows the image, container name, privileged mode and mounts before approving, and grants the package user access to one root-owned broker instead of flipping the package to run-as: root. Documented that the approval survives upgrades, that a new runner image requires a re-approval, and that uninstalling revokes everything.
  • Security notes added: mounting the Docker socket is root-equivalent on the NAS; recommend fine-grained tokens scoped to runner registration.
  • Install wizard now accepts fine-grained personal access tokens: the validator required exactly 40 characters, which rejected the more secure github_pat_* tokens (maxLength raised to 255).
  • Fixed the Releases link, which pointed to a misspelled repository name (github-runner-synology).

Verification

  • install_uifile still parses as valid JSON.
  • Doc-only otherwise; the behavioural change ships with the builder PR and needs a functional pass on real DSM hardware before release.

🤖 Generated with Claude Code

https://claude.ai/code/session_01R1PGYcSzo7GMyvgxFumZJ6


Generated by Claude Code

The package builder's elevated mode was reworked: the install no longer
fails on purpose, and the manual root step becomes a single reviewable
'sudo /var/packages/GithubRunner/scripts/elevate' command that grants the
package user access to a root-owned broker instead of flipping the whole
package to run-as root. Update the installation steps accordingly, add
security notes about the Docker socket and the access token, and fix the
Releases link pointing to a misspelled repository name.

Also allow fine-grained personal access tokens in the install wizard: the
previous validator only accepted exactly 40 characters, rejecting the
more secure github_pat_* tokens.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R1PGYcSzo7GMyvgxFumZJ6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants