Fix README docker run port so the API is reachable#188
Merged
Conversation
The documented `docker run -p 8001:8000 ... rbardaji/ndp-ep-api` mapped to container port 8000, but the published all-in-one image serves the app through nginx on port 80, so following the README verbatim left the API unreachable. Map to :80 and explain the all-in-one image/port. Also list the Web UI and /health endpoint in "Verify Installation" and note the compose default port. Closes #187
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
1 participant
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.
Closes #187
Problem
The "Run with Docker" section documented:
The published
rbardaji/ndp-ep-apiimage is the all-in-one build, which serves the app through nginx on container port 80 (nothing listens on 8000 in that image). So mapping the host port to container8000connects to nothing, and every verification URL fails even though the container is up and healthy — exactly the failure a user hits when following the README as written.Changes
docker runnow maps to:80(docker run -p 8001:80 ...), with a short note explaining the all-in-one image and its port./ui/) and the liveness endpoint (/health), and notes thatdocker composeuses host port8002by default (vs8001for thedocker runexample).0.32.2(swagger_settings.py+CHANGELOG.md).Testing
Documentation-only change; the only code change is the version string (existing tests mock the version, so none are affected).