Skip to content

chore: add docs for sharing ports #13136

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
May 3, 2024
Merged

chore: add docs for sharing ports #13136

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72fe3ee
chore: add docs for sharing ports
f0ssel May 3, 2024
51ebf0a
fmt
f0ssel May 3, 2024
c5df8c7
update image
f0ssel May 3, 2024
6bbbca1
minor refactors
stirby May 3, 2024
701dbc9
promoted headings to render (enterprise) label
stirby May 3, 2024
47331f5
fmt
stirby May 3, 2024
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
Prev Previous commit
Next Next commit
promoted headings to render (enterprise) label
  • Loading branch information
@stirby
stirby committed May 3, 2024
commit 701dbc90bcb7c2ea3c7cacd3ba9ebfcc799da184
8 changes: 4 additions & 4 deletions docs/networking/port-forwarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ accessible by users outside of the Coder deployment.

![Port forwarding from an app in the UI](../images/networking/portforwarddashboard.png)

### Accessing workspace ports
## Accessing workspace ports

Another way to port forward in the dashboard is to use the "Open Ports" button
to specify an arbitrary port. Coder will also detect if apps inside the
Expand All @@ -101,7 +101,7 @@ only supported on Windows and Linux workspace agents).

![Port forwarding in the UI](../images/networking/listeningports.png)

#### Sharing ports
### Sharing ports

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
Expand All @@ -126,7 +126,7 @@ defined using the terraform provider can be overridden by sharing the port.
The sharing level is limited by the maximum level enforced by the template
in enterprise deployments, and not restricted in OSS deployments.

#### Configure maximum port sharing level (enterprise)
### Configure maximum port sharing level (enterprise)

Enterprise-licensed template admins can control the maximum port sharing level
for workspaces under a given template in the template settings. By default, the
Expand All @@ -136,7 +136,7 @@ end-users. OSS deployments allow all workspaces to share ports at both the

![Max port sharing level in the UI](../images/networking/portsharingmax.png)

#### Configuring port protocol
### Configuring port protocol

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
Expand Down
Loading