docs: DOC-1381: Uris and authentication#8030
Open
margaretkennedy wants to merge 3 commits into
Open
Conversation
…s and examples - Clarify Docker container name resolution requires same Docker network - Update docker-compose.yml examples to explicitly configure anonymous authentication - Remove obsolete version field from docker-compose.yml - Add manual Docker network setup examples as alternative to docker-compose - Add note about using container port vs host port when resolving by container name - Improve authentication requirement explanation for
margaretkennedy
added
documentation
Contributor
margaretkennedy
requested review from
Copilot and
devinrsmith
and removed request for
devonpallison
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Deephaven URI documentation (Python + Groovy) to clarify authentication requirements (anonymous auth) and improve Docker-based examples for cross-instance URI resolution, plus minor debugging-doc cleanup.
Changes:
- Update Shared Tickets links and
await_update/awaitUpdateguidance to point to the dedicated reference docs. - Expand Docker examples to explicitly configure anonymous authentication and add a non-Compose Docker network alternative.
- Remove Linux-specific
host.docker.internaltroubleshooting guidance from the PyCharm Docker debugging guide.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/python/how-to-guides/use-uris.md | Clarifies anonymous-auth requirement for URI resolution; improves Docker examples and linking. |
| docs/python/how-to-guides/debugging/docker-setup.md | Removes a Linux host.docker.internal note/checklist item in the debugging workflow. |
| docs/groovy/how-to-guides/use-uris.md | Mirrors the Python URI doc updates for Groovy (auth + Docker examples + linking). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
178
to
180
| - Verify the PyCharm debug server is running (green bug icon should be active). | ||
| - Check that port 4444 is not blocked by a firewall. | ||
| - On Linux, verify `host.docker.internal` is correctly configured. | ||
| - Ensure the port in `settrace` matches the PyCharm configuration. |
Comment on lines
+174
to
+176
| docker run -d --network dh-net --name table-producer -p 10000:10000 \ | ||
| --env START_OPTS=-DAuthHandlers=io.deephaven.auth.AnonymousAuthenticationHandler \ | ||
| ghcr.io/deephaven/server:latest |
Comment on lines
+178
to
+180
| docker run -d --network dh-net --name table-consumer -p 9999:10000 \ | ||
| --env START_OPTS=-DAuthHandlers=io.deephaven.auth.AnonymousAuthenticationHandler \ | ||
| ghcr.io/deephaven/server:latest |
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.
No description provided.