Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 16, 2025

Conversation

matifali
Copy link
Member

@matifali matifali commented Jul 15, 2025

Noticed that Coder Desktop was missing from port-forwarding docs which is kind of a big feature for Coder Connect.

preview

Notices it was missing from pthe ort forwarding docs which is kind of a big feature for Coder COnnect provides.
@matifali matifali self-assigned this Jul 15, 2025
@matifali matifali requested a review from ethanndickson July 15, 2025 09:31
@matifali matifali changed the title docs: mention Coder Desktop in port forwarding docs docs: update port forwarding docs to include Coder Desktop Jul 15, 2025
Comment on lines 9 to 22
There are multiple ways to forward ports in Coder:

- [Coder Desktop](../desktop/index.md)
- The `coder port-forward` command
- Dashboard
- SSH

The `coder port-forward` command is generally more performant than:
The performance of these methods generally follows 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.
Copy link
Contributor

@EdwardAngert EdwardAngert Jul 15, 2025

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 the Method column):

Method Details
Coder Desktop Uses a VPN tunnel to your workspace and provides access to all running ports.
The coder 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 for coder port-forward

Copy link
Member Author

@matifali matifali Jul 15, 2025

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pushed in 9f83570

Copy link
Contributor

@EdwardAngert EdwardAngert left a 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

Co-authored-by: Atif Ali <atif@coder.com>
Copy link
Member

@deansheather deansheather left a 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

@matifali matifali enabled auto-merge (squash) July 16, 2025 19:54
@matifali matifali merged commit ca6b5e3 into main Jul 16, 2025
30 checks passed
@matifali matifali deleted the atif/desktop-ports branch July 16, 2025 19:57
@github-actions github-actions bot locked and limited conversation to collaborators Jul 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants