docs: clarify Hub administrative access and port publishing - #471
Draft
DylanWelzel wants to merge 1 commit into
Draft
DylanWelzel wants to merge 1 commit into
DylanWelzel wants to merge 1 commit into
Conversation
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.
The Studio deployment warning appears late in the tutorial, and the standalone Docker example publishes administrative ports on all host interfaces. Users need the access requirements before starting either environment.
Add a shared Hub deployment and access-control guide and link it from the README, documentation landing page, and Studio, standalone, and Hub tutorials. Explain who should reach each service, distinguish the query API from administrative services, and document network restrictions, gateway coverage, browser access, and verification. Place warnings beside port lists and before startup commands, and bind the standalone example's published ports to
127.0.0.1. Retain the later Studio reminder and its existing#id2anchor.This is a documentation change; application authentication and listener defaults are unchanged.
Validation:
git diff --checkpasses.#id2anchor.bash -nand parsed the Compose mapping as YAML. No containers were started.