Skip to content

Commit c5e8e7e

Browse files
authored
docs: mention Coder Desktop in port forwarding docs
Notices it was missing from pthe ort forwarding docs which is kind of a big feature for Coder COnnect provides.
1 parent de4a270 commit c5e8e7e

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/user-guides/workspace-access/port-forwarding.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,25 @@ Port forwarding lets developers securely access processes on their Coder
66
workspace from a local machine. A common use case is testing web applications in
77
a browser.
88

9-
There are three ways to forward ports in Coder:
9+
There are multiple ways to forward ports in Coder:
1010

11+
- [Coder Desktop](../desktop/index.md)
1112
- The `coder port-forward` command
1213
- Dashboard
1314
- SSH
1415

15-
The `coder port-forward` command is generally more performant than:
16+
The performance of these methods generally follows in the following order.
1617

17-
1. The Dashboard which proxies traffic through the Coder control plane versus
18-
peer-to-peer which is possible with the Coder CLI
19-
1. `sshd` which does double encryption of traffic with both Wireguard and SSH
18+
1. Coder Desktop: as it uses a VPN tunnel to your workspace and provides access to all running ports.
19+
1. The `coder port-forward` command.
20+
1. The Dashboard, which proxies traffic through the Coder control plane versus
21+
peer-to-pee,r which is possible with the Coder CLI and Coder Desktop.
22+
1. `ssh`, which does double encryption of traffic with both Wireguard and SSH.
23+
24+
## Coder Desktop
25+
26+
[Coder Desktop](../desktop/index.md) provides seamless access to your remote workspaces, eliminating the need to install a CLI or manually configure port forwarding.
27+
Just install and access all your ports at `<workspace-name>.coder:PORT`.
2028

2129
## The `coder port-forward` command
2230

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

65-
### From an coder_app resource
73+
### From a coder_app resource
6674

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

0 commit comments

Comments
 (0)