mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: improve discoverability of automatic port forwarding via Coder Desktop (#25675)
This commit is contained in:
@@ -155,12 +155,25 @@ of tools for extending the capability of your workspace. If you have a request
|
||||
for a new IDE or tool, please file an issue in our
|
||||
[Modules repo](https://github.com/coder/registry/issues).
|
||||
|
||||
## Coder Desktop
|
||||
|
||||
[Coder Desktop](../desktop/index.md) is a native application that provides seamless access to your workspaces via a VPN tunnel. With Coder Desktop, you get:
|
||||
|
||||
- **Automatic port forwarding**: All workspace ports are available at `workspace-name.coder:PORT` with no manual setup
|
||||
- **SSH access**: Connect with `ssh workspace-name.coder` using any SSH client
|
||||
- **File sync**: Bidirectional file synchronization between local and remote directories
|
||||
|
||||
Coder Desktop is the recommended way to access workspace services for developers who want a seamless, native experience.
|
||||
|
||||
## Ports and Port forwarding
|
||||
|
||||
You can manage listening ports on your workspace page through with the listening
|
||||
You can manage listening ports on your workspace page through the listening
|
||||
ports window in the dashboard. These ports are often used to run internal
|
||||
services or preview environments.
|
||||
|
||||
> [!TIP]
|
||||
> For automatic access to all ports without manual configuration, use [Coder Desktop](../desktop/index.md).
|
||||
|
||||
You can also [share ports](./port-forwarding.md#sharing-ports) with other users,
|
||||
or [port-forward](./port-forwarding.md#the-coder-port-forward-command) through
|
||||
the CLI with `coder port forward`. Read more in the
|
||||
|
||||
@@ -17,8 +17,12 @@ There are multiple ways to forward ports in Coder:
|
||||
|
||||
## Coder Desktop
|
||||
|
||||
[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`.
|
||||
> [!TIP]
|
||||
> Coder Desktop is the recommended way to access workspace ports. It provides automatic port forwarding with no manual setup.
|
||||
|
||||
[Coder Desktop](../desktop/index.md) creates a VPN tunnel that automatically forwards every port in your workspace. Any service listening on a port is instantly accessible at `<workspace-name>.coder:PORT` from your local machine, with no additional commands or configuration.
|
||||
|
||||
This is the simplest option for most developers: install Coder Desktop, enable Coder Connect, and all ports just work. Connections are peer-to-peer for the best performance.
|
||||
|
||||
## The `coder port-forward` command
|
||||
|
||||
|
||||
Reference in New Issue
Block a user