Skip to content

Commit 3416f6d

Browse files
authored
chore: update port-forwarding documentation (#10916)
1 parent 6808dae commit 3416f6d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/networking/port-forwarding.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,20 @@ For more examples, see `coder port-forward --help`.
5252
> [wildcard access URL](../admin/configure.md#wildcard-access-url). If an access
5353
> URL is not specified, Coder will create
5454
> [a publicly accessible URL](../admin/configure.md#tunnel) to reverse proxy the
55-
> deployment, and port forwarding will work. There is a known limitation where
56-
> if the port forwarding URL length is greater than 63 characters, port
57-
> forwarding will not work.
55+
> deployment, and port forwarding will work.
56+
>
57+
> There is a
58+
> [DNS limitation](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.1)
59+
> where each segment of hostnames must not exceed 63 characters. If your app
60+
> name, agent name, workspace name and username exceed 63 characters in the
61+
> hostname, port forwarding via the dashboard will not work.
5862
5963
### From an arbitrary port
6064

6165
One way to port forward in the dashboard is to use the "Port forward" button to
62-
specify an arbitrary port. Coder will also detect if processes are running, and
63-
will list them below the port picklist to click an open the running processes in
64-
the browser.
66+
specify an arbitrary port. Coder will also detect if apps inside the workspace
67+
are listening on ports, and list them below the port input (this is only
68+
supported on Windows and Linux workspace agents).
6569

6670
![Port forwarding in the UI](../images/port-forward-dashboard.png)
6771

0 commit comments

Comments
 (0)