Skip to content

docs(installation): add manual gateway instructions#1319

Draft
drew wants to merge 10 commits into
mainfrom
manual-gateway-install-docs
Draft

docs(installation): add manual gateway instructions#1319
drew wants to merge 10 commits into
mainfrom
manual-gateway-install-docs

Conversation

@drew
Copy link
Copy Markdown
Collaborator

@drew drew commented May 12, 2026

Summary

Add concise manual gateway and CLI binary setup notes for users who do not want package-manager installation, especially immutable or image-based Linux systems. Move gateway runtime configuration details to a dedicated Gateway Configuration reference page.

Related Issue

Addresses review discussion #1285 (comment)

Changes

  • Add manual gateway binary setup with inline target detection and latest-release downloads.
  • Add a VM driver note for installing openshell-driver-vm under $HOME/.local/libexec/openshell.
  • Add manual CLI binary setup with inline target detection and latest-release downloads.
  • Add Gateway Configuration reference page with gateway environment variables and their purpose.
  • Link installation and gateway management docs to the new reference.

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Additional validation:

  • git diff --check
  • mise run docs
  • mise run markdown:lint

mise run pre-commit did not pass because cargo fmt --all -- --check reported an unrelated formatting diff in crates/openshell-driver-kubernetes/src/driver.rs.

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable; not needed for this docs-only install update)

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew requested review from a team, derekwaynecarr, maxamillion and mrunalp as code owners May 12, 2026 05:57
@github-actions
Copy link
Copy Markdown

drew added 2 commits May 11, 2026 23:02
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew marked this pull request as draft May 12, 2026 06:18
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 12, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

drew added 7 commits May 11, 2026 23:20
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
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.

1 participant