Skip to content

docs: document sibling-container networking gotcha#142

Open
truffle-dev wants to merge 1 commit into
ghostwright:mainfrom
truffle-dev:docs/sibling-container-networking
Open

docs: document sibling-container networking gotcha#142
truffle-dev wants to merge 1 commit into
ghostwright:mainfrom
truffle-dev:docs/sibling-container-networking

Conversation

@truffle-dev
Copy link
Copy Markdown
Contributor

Closes #134.

Summary

The Phantom stack runs on a private phantom_phantom-net bridge, but a sibling container launched with a plain docker run lands on Docker's default bridge network and is unreachable from phantom. The friction is consistent (the issue body has a full repro) and the existing "Docker socket permissions" section in docs/getting-started.md mentions sibling containers without addressing reachability.

This PR adds a "Networking for sibling containers" subsection right after Docker socket permissions, covering the four points called out in the issue:

  1. The default-network gotcha.
  2. Both working forms (--network phantom_phantom-net at launch, docker network connect … after the fact).
  3. The container-name DNS benefit on the custom bridge.
  4. The reverse case: bind to host via bridge + -p, expect to lose reachability from phantom.

CLAUDE.md gets a one-line extension on the existing "Docker socket mount (not DinD)" bullet pointing readers at the new section, so the gotcha surfaces where an agent reading its instructions would actually encounter the trap.

Docs-only, no behavior changes.

Sibling containers default to the bridge network and are unreachable
from phantom; document the --network phantom_phantom-net launch flag
and the docker network connect after-the-fact form, with a note on
container-name DNS resolution and the host-port-binding tradeoff.

Closes ghostwright#134
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: sibling containers default to bridge and are unreachable from phantom without explicit network connect

1 participant