Skip to content

fix(DOCS): add note for macos to fix docker containers startup failure #2544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shamardy merged 2 commits into from
Jul 24, 2025
Merged

fix(DOCS): add note for macos to fix docker containers startup failure #2544

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ac9080
add note for macos to resolve failed containers
Jul 23, 2025
3fd7268
fixed (review): phrasing
Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/DEV_ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@
```
9. Try `cargo test --all --features run-docker-tests -- --test-threads=16`.

Note for MacOS users:
- The UTXO 'testblockchain' docker container may fail to start due to TCP port conflict with MacOS AirPlay Receiver (using the same 7000 port). Disabling AirPlay Receiver resolves this problem.
Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we not changing the container port instead of telling users to disable AirPlay 🤔

Copy link
Copy Markdown
Collaborator Author

@dimxy dimxy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could suggest the user to change the port by themselves, as another option

Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not changing the container port directly on KDF? That way users don't have to change or know anything about it.

Copy link
Copy Markdown
Collaborator Author

@dimxy dimxy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may change it ofc, no guarantee though that there would not conflicts with other services.
We may rephrase the note as more general like: if containers do not start check for port conflicts, for example for MacOS it may be a conflict with AirPlay


- The 'nucleusd' test docker container (and the dependent 'ibc-relayer' container) may fail to start on MacOS. The MacOS docker "Enable host networking" option may help with this issue.
Copy link
Copy Markdown

@onur-ozkan onur-ozkan Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would re-write this part as:

"nucleusd container (along with the dependent ibc-relayer container) requires host network access, but on MacOS, by default containers can not access to host network. Therefore, the "Enable host networking" option must be enabled to allow the nucleusd containers to run properly"

Copy link
Copy Markdown
Collaborator

@shamardy shamardy Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dimxy feel free to open another PR for these changes if you want. I guess I merged this a bit early


## Running WASM tests

1. Set up [WASM Build Environment](../docs/WASM_BUILD.md#Setting-up-the-environment)
Expand Down
Loading