docs(container-gateway): fix Docker driver setup for containerized gateway#1419
Merged
TaylorMutch merged 1 commit intoJun 3, 2026
Merged
Conversation
drew
reviewed
May 18, 2026
c1ff3e7 to
05176ab
Compare
elezar
reviewed
May 18, 2026
elezar
reviewed
May 18, 2026
elezar
reviewed
May 18, 2026
elezar
reviewed
May 18, 2026
05176ab to
a8cc6c0
Compare
Contributor
Author
TaylorMutch
reviewed
May 21, 2026
0193302 to
d25036a
Compare
Collaborator
|
/ok to test d25036a |
TaylorMutch
reviewed
Jun 1, 2026
TaylorMutch
reviewed
Jun 1, 2026
Collaborator
TaylorMutch
left a comment
There was a problem hiding this comment.
One comment otherwise LGTM
elezar
reviewed
Jun 2, 2026
elezar
reviewed
Jun 2, 2026
elezar
reviewed
Jun 2, 2026
elezar
reviewed
Jun 2, 2026
elezar
reviewed
Jun 2, 2026
Contributor
Author
|
@elezar @TaylorMutch addressed all comments, just as a heads up, I'm heading on PTO, so if we don't get this to completion on this iteration, it's fine, but this will be stagnant for a few weeks |
…teway The existing docs omitted or misstated several requirements when running the gateway as a container with the Docker compute driver: - OPENSHELL_GRPC_ENDPOINT is required; the Docker driver uses only the scheme (http/https) — host and port are substituted automatically with host.openshell.internal and the gateway's own bind port - Supervisor binary must be extracted to a host path before starting the gateway; bind-mount sources are resolved by the host Docker daemon so the path must be identical inside and outside the gateway container - Docker socket access requires adding the docker group (UID 1000 default) - Port binding should remain 127.0.0.1; Docker driver adds a bridge listener automatically - add --server-san host.openshell.internal to generate-certs for mTLS - Complete the mTLS docker run with all Docker driver requirements - Add deploy/docker/gateway.toml — TOML config for the Docker driver - Add deploy/docker/docker-compose.yml referencing the TOML - Add docs/get-started/tutorials/docker-compose.mdx tutorial page - Remote gateway registration instructions (--remote flag) Address reviewer feedback: - Move Docker Compose tutorials card to the bottom of the list - Replace inline YAML snippet in Docker Compose section with a reference to deploy/docker/ to avoid drift - Clarify OPENSHELL_DB_URL is safe in compose.yml (plain SQLite path, no credentials); the TOML block targets credential-bearing DSNs - Note that ./ in source: resolves relative to the compose file directory - Clarify that only the scheme from OPENSHELL_GRPC_ENDPOINT matters - Add note that the tilde volume mount resolves to the same absolute path on both host and container
d25036a to
2953e1c
Compare
Collaborator
|
/ok to test 2953e1c |
TaylorMutch
approved these changes
Jun 3, 2026
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
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
The container-gateway docs were missing or misstating several requirements for running the gateway as a Docker container with the Docker compute driver. Validated by deploying on a Fedora Kinoite (bootc) system.
Related Issue
N/A — discovered during hands-on deployment on a bootc system.
Changes
OPENSHELL_GRPC_ENDPOINTto all Docker driver examples; the Docker driver uses only the scheme (http/https) — host and port are substituted automatically withhost.openshell.internaland the gateway's own bind port127.0.0.1:8080— the Docker driver automatically binds the gateway to the bridge network interface viagateway_bind_addresses(), so exposing on0.0.0.0is unnecessarygroup_add: [docker]to the compose service — the gateway image runs asnvs:nvs(UID 1000) which needs the docker group to access the Docker socket--remoteflag for LAN access)--server-san host.openshell.internaltogenerate-certsin the mTLS section — sandbox containers resolvehost.openshell.internalto reach the gateway, so this SAN must be present in the server cert--group-add docker, supervisor binary mount,OPENSHELL_GRPC_ENDPOINT,OPENSHELL_DOCKER_SUPERVISOR_BIN)deploy/docker/gateway.toml— TOML config for the Docker driver; binds to127.0.0.1since the Docker driver adds the bridge listener automaticallydeploy/docker/docker-compose.yml— referencesgateway.tomlas the primary config source; setscommand: []to clear the default CMD; keeps only three env vars that cannot be expressed in TOML--privilegedneeded, only socket read/write accessdocs/get-started/tutorials/docker-compose.mdx— end-to-end tutorial for Docker Compose setupAddress reviewer feedback:
deploy/docker/to avoid driftOPENSHELL_DB_URLis safe incompose.yml(plain SQLite path, no credentials); the TOML block targets credential-bearing DSNs likepostgresql://user:pass@host/db./insource:resolves relative to the compose file directory, not the caller's CWDOPENSHELL_GRPC_ENDPOINTmattersTesting
mise run pre-commitpasses (markdownlint clean; python:proto failure is pre-existing env issue unrelated to this change)Checklist