You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/networking/port-forwarding.md
+33-13Lines changed: 33 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -91,44 +91,64 @@ accessible by any user authenticated to the Coder deployment, and `public` -
91
91
accessible by users outside of the Coder deployment.
92
92
93
93
<!--- TODO: Update this image to match the rest on the page -->
94
+
94
95
95
96
96
97
### Accessing workspace ports
97
98
98
-
Another way to port forward in the dashboard is to use the "Open Ports" button to
99
-
specify an arbitrary port. Coder will also detect if apps inside the workspace
100
-
are listening on ports, and list them below the port input (this is only
101
-
supported on Windows and Linux workspace agents).
99
+
Another way to port forward in the dashboard is to use the "Open Ports" button
100
+
to specify an arbitrary port. Coder will also detect if apps inside the
101
+
workspace are listening on ports, and list them below the port input (this is
102
+
only supported on Windows and Linux workspace agents).
102
103
103
104
104
105
105
106
#### Sharing ports
106
107
107
-
We allow developers to share ports as URLs, either with other authenticated coder users or publicly. Using the open ports interface, developers can assign a sharing levels that match our `coder_app`’s share option in [Coder terraform provider](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app#share).
108
+
We allow developers to share ports as URLs, either with other authenticated
109
+
coder users or publicly. Using the open ports interface, developers can assign a
110
+
sharing levels that match our `coder_app`’s share option in
-`owner` (Default): The implicit sharing level for all listening ports, only visible to the workspace owner
110
-
-`authenticated`: Accessible by other authenticated Coder users on the same deployment.
113
+
-`owner` (Default): The implicit sharing level for all listening ports, only
114
+
visible to the workspace owner
115
+
-`authenticated`: Accessible by other authenticated Coder users on the same
116
+
deployment.
111
117
-`public`: Accessible by any user with the associated URL.
112
118
113
-
Once a port is shared at either `authenticated` or `public` levels, it will stay pinned in the open ports UI for better accessibility regardless of whether or not it is still accessible.
119
+
Once a port is shared at either `authenticated` or `public` levels, it will stay
120
+
pinned in the open ports UI for better accessibility regardless of whether or
121
+
not it is still accessible.
114
122
115
123
116
124
117
-
This can also be used to change the sharing level of `coder_app`s by entering their port number in the shared ports UI. The `share` attribute of `coder_app`s defined using the terraform provider can be overridden by sharing the port, but is limited by the maximum port sharing level enforced by the template (Enterprise).
125
+
This can also be used to change the sharing level of `coder_app`s by entering
126
+
their port number in the shared ports UI. The `share` attribute of `coder_app`s
127
+
defined using the terraform provider can be overridden by sharing the port, but
128
+
is limited by the maximum port sharing level enforced by the template
129
+
(Enterprise).
118
130
119
-
By default, OSS deployments allow all workspaces to share ports at both the `authenticated` and `public` levels.
131
+
By default, OSS deployments allow all workspaces to share ports at both the
132
+
`authenticated` and `public` levels.
120
133
121
134
#### Configure sharing level (enterprise)
122
135
123
-
Enterprise-licensed template admins can control the maximum port sharing level for workspaces under a given template in the template settings. By default, the maximum sharing level is set to `Owner`, meaning port sharing is disabled for end-users.
136
+
Enterprise-licensed template admins can control the maximum port sharing level
137
+
for workspaces under a given template in the template settings. By default, the
138
+
maximum sharing level is set to `Owner`, meaning port sharing is disabled for
139
+
end-users.
124
140
125
141
126
142
127
143
#### Configuring port protocol
128
144
129
-
Both listening and shared ports can be configured to use either `HTTP` or `HTTPS` to connect to the port. For listening ports the protocol selector applies to any port you input or select from the menu. Shared ports have protocol configuration for each shared port individually.
145
+
Both listening and shared ports can be configured to use either `HTTP` or
146
+
`HTTPS` to connect to the port. For listening ports the protocol selector
147
+
applies to any port you input or select from the menu. Shared ports have
148
+
protocol configuration for each shared port individually.
130
149
131
-
You can access any port on the workspace and can configure the port protocol manually by appending a `s` to the port in the URL.
150
+
You can access any port on the workspace and can configure the port protocol
151
+
manually by appending a `s` to the port in the URL.
0 commit comments