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.

Sign up for GitHub

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
Merged

docs: update port forwarding docs to include Coder Desktop #18870

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c5e8e7e
docs: mention Coder Desktop in port forwarding docs
matifali Jul 15, 2025
9f83570
lists into table; access ports
EdwardAngert Jul 15, 2025
a3fe2dc
add intro line back
EdwardAngert Jul 15, 2025
202793d
Update docs/user-guides/workspace-access/port-forwarding.md
EdwardAngert Jul 15, 2025
79627ee
apply review suggestions
matifali Jul 16, 2025
2c20e7e
Update port-forwarding.md
matifali Jul 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/user-guides/workspace-access/port-forwarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ Port forwarding lets developers securely access processes on their Coder
workspace from a local machine. A common use case is testing web applications in
a browser.

There are three ways to forward ports in Coder:
There are multiple ways to forward ports in Coder:

- The `coder port-forward` command
- Dashboard
- SSH
| Method | Details |
|:----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Coder Desktop](#coder-desktop) | Uses a VPN tunnel to your workspaces and provides access to all running ports. Supports peer-to-peer connections for the best performance. |
| [`coder port-forward` command](#the-coder-port-forward-command) | Can be used to forward specific TCP or UDP ports from the remote workspace so they can be accessed locally. Supports peer-to-peer connections for the best performance. |
| [Dashboard](#dashboard) | Proxies traffic through the Coder control plane. |
| [SSH](#ssh) | Forwards ports over an SSH connection. |

The `coder port-forward` command is generally more performant than:
## Coder Desktop

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
[Coder Desktop](../desktop/index.md) provides seamless access to your remote workspaces, eliminating the need to install a CLI or manually configure port forwarding.
Access all your ports at `<workspace-name>.coder:PORT`.

## The `coder port-forward` command

Expand Down Expand Up @@ -62,7 +64,7 @@ where each segment of hostnames must not exceed 63 characters. If your app
name, agent name, workspace name and username exceed 63 characters in the
hostname, port forwarding via the dashboard will not work.

### From an coder_app resource
### From a coder_app resource

One way to port forward is to configure a `coder_app` resource in the
workspace's template. This approach shows a visual application icon in the
Expand Down
Loading