Document the -c port-reachability limitation#1156
Open
mcfnord wants to merge 3 commits into
Open
Conversation
-c connects directly and, unlike selecting a server from the GUI directory list, does not have a directory open the server's port. Note that the port must be reachable from the client (router, cloud firewall/security group, and/or OS firewall), whether or not the server is listed in a directory. Addresses jamulussoftware#1122 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
mcfnord
commented
Jul 21, 2026
pljones
reviewed
Jul 21, 2026
mcfnord
commented
Jul 23, 2026
3 tasks
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
2 participants
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.
Short description of changes
Expands the
-c/--connectentry inInclude-Client-Commands.mdwith concise guidance on why it can fail to reach a server that the GUI reaches fine.-cconnects directly to the given address. Unlike selecting a server from the directory list in the GUI, it does not have a directory open the server's port, so the port must already be reachable from the client — which may require opening it in the router, cloud firewall/security group, and/or OS firewall. This holds whether or not the server is listed in a directory. Today the docs don't mention this and the failure is silent and confusing.Context: Fixes an issue? Related issues
Relates to #1122. This documents the current behaviour and its limitation; it intentionally does not close #1122, which stays open for the separate discussion of improving
-citself (directory-assisted hole-punch), which would land in the Jamulus repo.Status of this Pull Request
Working implementation.
What is missing until this pull request can be merged?
Nothing outstanding — documentation only, single-line change to one English file. Ready for review.
Does this need translation?
YES (new English string) — hence this PR targets the
next-releasebranch.Checklist