docs(installation): add container gateway page with docker run and compose examples#1321
Merged
Merged
Conversation
ericcurtin
requested review from
a team,
derekwaynecarr,
maxamillion and
mrunalp
as code owners
…mpose examples Add a dedicated page documenting how to run the OpenShell gateway as a container using docker run, docker-compose, or podman, without the system package manager installer. This is useful for users on immutable OS distributions (Fedora CoreOS, bootc-based images, Silverblue) where the standard install.sh path is not appropriate, and for container-first environments. Covers a quick-start with TLS disabled (localhost-bound), a full mTLS setup using the gateway's generate-certs subcommand, a docker-compose example, and a Podman variant. Closes the gap raised in NVIDIA#1285. Signed-off-by: Eric Curtin <eric.curtin@docker.com>
ericcurtin
force-pushed
the
docs-docker-run-compose/ec
branch
from
ce6173a to
aeba2b9
Compare
5 tasks
johntmyers
approved these changes
May 15, 2026
cgwalters
reviewed
May 15, 2026
| position: 4 | ||
| --- | ||
|
|
||
| Use this approach when you want to run the OpenShell gateway as a container instead of installing it with the system package manager. This is useful on immutable OS distributions (Fedora CoreOS, bootc-based images, Silverblue) where the standard installer is not appropriate, or anywhere you prefer a container-first workflow. |
Contributor
There was a problem hiding this comment.
But since a key part of the UX here is having the CLI, I think that's not enough right?
In a different project, what I did is include the CLI binaries in the container image, and then support extracting them - the CLI should be a relatively thin bootstrap tool that uses the remote server as source of truth ideally.
| Register the gateway with the CLI: | ||
|
|
||
| ```shell | ||
| openshell gateway add http://127.0.0.1:8080 --local --name local |
Contributor
There was a problem hiding this comment.
i.e. here we assume something that doesn't exist
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a new documentation page covering how to run the OpenShell gateway as a container (docker run, docker-compose, Podman) without the system package manager installer. This is the approach discussed in #1285 — close that PR and ship the docs instead.
Related Issue
Closes #1285
Changes
docs/about/container-gateway.mdx: new page with quick-start (TLS-disabled, localhost-bound), full mTLS setup using the gateway'sgenerate-certssubcommand, a docker-compose example, and a Podman variant.docs/about/installation.mdx: link to the new page from Next Steps.docs/about/supported-agents.mdx,docs/about/release-notes.mdx: shiftedpositionvalues (4→5 and 5→6) to make room for the new page at position 4.Testing
mise run pre-commitpasses (markdownlint-cli2 reports 0 errors on the new file)Checklist