docs(docker): document API_SERVER_* env vars (salvage #11758) - #20409
Merged
Conversation
…compatible endpoint Salvage of #11758. The PR's original diff was stale (the Docker Compose section on main has been heavily refactored — dashboard is now an embedded side-process, not a separate service), so the useful bit (API server env var requirements) is applied as a note on the basic `docker run` example. Co-authored-by: xiangyong <xiangyong@zspace.cn>
alt-glitch
added
type/docs
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
2 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.
Documents that the OpenAI-compatible API server on port 8642 is gated on
API_SERVER_ENABLED=trueand needsAPI_SERVER_HOST=0.0.0.0+API_SERVER_KEYto reach it from outside the container.Changes:
website/docs/user-guide/docker.md— API_SERVER_* env var note on the basicdocker runexample (+15)scripts/release.py— AUTHOR_MAP entry for CES4751The PR's original diff was stale (main's Docker Compose section has been heavily refactored — dashboard is now an embedded side-process via
HERMES_DASHBOARD=1, not a separate service, and the entrypoint auto-passes--insecure). The useful bit (API_SERVER_* env var requirements) is applied as a note on the basicdocker runblock.Verified against
gateway/config.py:1309—API_SERVER_ENABLEDenv var gates the API server.Closes #11758 via salvage.
Original PR by @CES4751 — authorship preserved.