Skip to content

Update documentation to match the current environment variables - #72

Merged
existemi merged 2 commits into
rl/github-patfrom
rl/docs
Aug 20, 2026
Merged

Update documentation to match the current environment variables#72
existemi merged 2 commits into
rl/github-patfrom
rl/docs

Conversation

@existemi

@existemi existemi commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Description

Bring the documentation back in line with the code.

  • Correct the GitHub Enterprise Server section, which instructed setting GITHUB_API_URL. That variable is now ignored, and following the old instructions produces a warning on every startup
  • Mark GITHUB_API_URL as deprecated and ignored in the README and the example .env
  • Document seven environment variables that appeared in neither the README nor the example .env: GITHUB_RUNNER_VERSION, MAX_RUNNERS, ORKA_NAMESPACE, RUNNER_DEREGISTRATION_TIMEOUT, and RUNNER_DEREGISTRATION_POLL_INTERVAL, plus ENABLE_RECONCILIATION and VM_TRACKER_INTERVAL which were only in the example .env, and ORKA_VM_USERNAME and ORKA_VM_PASSWORD which were only in the README
  • Clarify that GITHUB_TOKEN is always a github.com token, even on GHES, that it is used only to look up the latest runner release, and that it is unrelated to GITHUB_PAT. Note the 60 requests per hour unauthenticated limit and the 403 startup failure that follows from exceeding it
  • Note that GITHUB_RUNNER_VERSION takes a bare version with no leading v, and that setting it removes the startup dependency on api.github.com entirely
  • Add a note to the GitHub App setup guide that App authentication covers repository and organization runners only, linking to the enterprise section

Every environment variable defined in pkg/env/constants.go now appears in both the README and the example .env.

@existemi
existemi marked this pull request as ready for review August 19, 2026 02:30
@existemi
existemi requested a review from a team as a code owner August 19, 2026 02:30
@ispasov

ispasov commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

nit — examples/.env: A few of the new keys are set to live values rather than commented placeholders — GITHUB_RUNNER_VERSION="2.336.0", ORKA_VM_USERNAME/PASSWORD="admin", and MAX_RUNNERS=9000. Since this file is meant to be copied as a starting point, anyone beginning from it silently pins the runner to 2.336.0 and inherits these as active config. Suggest commenting them out (like the other optionals) so the documented default is what actually takes effect unless the user opts in. Everything else reads accurately and matches the code.

@ispasov ispasov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — docs read accurately and match the code (the GITHUB_API_URL deprecation, the "GITHUB_TOKEN is always a github.com token even on GHES" clarification, and the derived-API-URL behavior). Approving; the only thing outstanding is the non-blocking examples/.env nit (a few new keys set to live values rather than commented placeholders) — feel free to fold that in or ignore.

@existemi

Copy link
Copy Markdown
Contributor Author

nit — examples/.env: A few of the new keys are set to live values rather than commented placeholders — GITHUB_RUNNER_VERSION="2.336.0", ORKA_VM_USERNAME/PASSWORD="admin", and MAX_RUNNERS=9000. Since this file is meant to be copied as a starting point, anyone beginning from it silently pins the runner to 2.336.0 and inherits these as active config. Suggest commenting them out (like the other optionals) so the documented default is what actually takes effect unless the user opts in. Everything else reads accurately and matches the code.

Good points. I have gone ahead and commented out everything that is default with the examples defaulting to the default value as well

@existemi
existemi merged commit 95af8a4 into main Aug 20, 2026
4 checks passed
@existemi
existemi deleted the rl/docs branch August 20, 2026 20:38
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