docs(docker): warn about macOS AirPlay 5000 conflict for MLflow port#97
Open
0xghost42 wants to merge 1 commit into
Open
docs(docker): warn about macOS AirPlay 5000 conflict for MLflow port#970xghost42 wants to merge 1 commit into
0xghost42 wants to merge 1 commit into
Conversation
Closes sentient-agi#34. macOS Monterey and later bind 0.0.0.0:5000 for the AirPlay Receiver service. Running 'docker-up-full' on a stock macOS host therefore fails with Ports are not available: exposing port TCP 0.0.0.0:5000 -> ... bind: address already in use The MLflow host port is already env-overridable (${MLFLOW_PORT:-5000}), but the conflict was not documented anywhere the user encounters before running compose. Several users (issue sentient-agi#34, plus follow-ups) hit this and had to discover the .env knob on their own. This change keeps the default at 5000 for backwards compatibility and adds the AirPlay caveat in three discoverable places: - README.md: a callout under 'Services Available' next to the MLflow URL. - .env.example: a NOTE block above MLFLOW_TRACKING_URI explaining the collision and the recommended override (e.g. MLFLOW_PORT=5050). - docker-compose.yaml: a comment immediately above the mlflow ports mapping so anyone reading the compose file sees the warning in context. No behaviour change; default port is unchanged. macOS users with AirPlay Receiver enabled now have a clear escape hatch in every place they would look.
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.
Summary
Closes #34.
macOS Monterey and later bind
0.0.0.0:5000for the AirPlay Receiver service. Runningdocker-up-fullon a stock macOS host therefore fails with:The MLflow host port is already env-overridable (
${MLFLOW_PORT:-5000}indocker-compose.yaml), but this collision is not documented anywhere the user encounters before running compose. The reporter in #34 (and at least two follow-ups in the comment thread) had to discover the.envknob on their own.Change
Default port stays at 5000 for backwards compatibility — no behaviour change for users without AirPlay Receiver enabled. Add the caveat in the three discoverable places:
README.md: callout under Services Available right next tohttp://localhost:5000..env.example: a NOTE block aboveMLFLOW_TRACKING_URIexplaining the collision and the recommended override (e.g.MLFLOW_PORT=5050).docker-compose.yaml: a comment immediately above themlflowports:block so anyone reading the compose file sees the warning in context.Verification
docker-compose -f docker-compose.yaml configparses cleanly.Why not change the default
Changing the default away from 5000 would silently break users who have
MLFLOW_TRACKING_URI=http://127.0.0.1:5000in their existing.env(the value currently shipped in.env.example). Documenting + signposting the override is the lowest-risk fix that still cuts the reported friction.