- Notifications
You must be signed in to change notification settings - Fork1k
docs: update port forwarding docs to include Coder Desktop#18870
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation
Notices it was missing from pthe ort forwarding docs which is kind of a big feature for Coder COnnect provides.
| There aremultiple ways to forward ports in Coder: | ||
| -[Coder Desktop](../desktop/index.md) | ||
| - The`coder port-forward` command | ||
| - Dashboard | ||
| - SSH | ||
| The`coder port-forward` command is generallymore performant than: | ||
| Theperformance of these methods generallyfollows in the following order. | ||
| 1. The Dashboard which proxies traffic through the Coder control plane versus | ||
| peer-to-peer which is possible with the Coder CLI | ||
| 1.`sshd` which does double encryption of traffic with both Wireguard and SSH | ||
| 1. Coder Desktop: as it uses a VPN tunnel to your workspace and provides access to all running ports. | ||
| 1. The`coder port-forward` command. | ||
| 1. The Dashboard, which proxies traffic through the Coder control plane versus | ||
| peer-to-pee,r which is possible with the Coder CLI and Coder Desktop. | ||
| 1.`ssh`, which does double encryption of traffic with both Wireguard and SSH. |
EdwardAngertJul 15, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@matifali what do you think of a table here instead?
maybe something like this (and we can link more from theMethod column):
| Method | Details |
|---|---|
| Coder Desktop | Uses a VPN tunnel to your workspace and provides access to all running ports. |
Thecoder port-forward command | (details) |
| Dashboard | Proxies traffic through the Coder control plane versus peer-to-peer which is possible with the Coder CLI and Coder Desktop. |
| SSH | Double-encrypts traffic with both Wireguard and SSH. |
GitHub won't let me suggest on this block of lines, but if it works, I can push a commit with it - I just need something forcoder port-forward
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Looks good. Thanks ❤️ . feel free to push to the PR branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
pushed in9f83570
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
someone should double-check my changes + approving so that I'm not blocking if they're ok
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Atif Ali <atif@coder.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Looks fine from a technical perspective
Uh oh!
There was an error while loading.Please reload this page.
ca6b5e3 intomainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Noticed that Coder Desktop was missing from port-forwarding docs which is kind of a big feature for Coder Connect.
preview