docs: fix proxy_command examples to use explicit hostname:port instead of %h:%p #542
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.
The current documentation and examples incorrectly show
proxy_command
using OpenSSH-style%h:%p
placeholders, but Paramiko's ProxyCommand doesn't support these placeholders like OpenSSH does. This leads to connection failures when users try to use the documented examples.Problem
The documentation in
doc/context.md
and example inexamples/machine/ssh_proxy_command.json
show:However, Paramiko's
ProxyCommand
expects explicit hostname and port values, not placeholders. The working tests intests/test_ssh_jump_host.py
already use the correct format:Solution
This PR updates the documentation and examples to use the correct explicit hostname:port format that works with Paramiko:
internal-server.company.com:22
instead of%h:%p
ssh_proxy_command.json
to match the working format.gitignore
patternsTechnical Details
The code implementation was already correct - it expects explicit hostname:port values in
proxy_command
and properly converts them to%h:%p
for rsync compatibility when needed. Only the documentation needed fixing to match the actual working implementation.Users can now follow the examples without encountering connection failures due to unsupported placeholder syntax.
Fixes #541.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.