synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update port forward dashboard docs for coder_app, sharing, and showing running processes (#4876)

Browse Source 
* chore: update port forward dashboard docs for coder_app and sharing

* Update docs/networking/port-forwarding.md

Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
sharkymark
2022-11-03 10:44:56 -05:00
committed by GitHub
parent 7f0f522b92
commit 9cd74f307c
2 changed files with 30 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/coderapp-port-forward.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 159 KiB

32
docs/networking/port-forwarding.md
View File

@ -47,11 +47,39 @@ For more examples, see `coder port-forward --help`.
> To enable port forwarding via the dashboard, Coder must be configured with a
> [wildcard access URL](../admin/configure.md#wildcard-access-url).
Use the "Port forward" button in the dashboard to access ports
running on your workspace.
### From an arbitrary port
One way to port forward in the dashboard is to use the "Port forward" button to specify an arbitrary port. Coder will also detect if processes are running, and will list them below the port picklist to click an open the running processes in the browser.
![Port forwarding in the UI](../images/port-forward-dashboard.png)
### From an coder_app resource
Another way to port forward is to configure a `coder_app` resource in the workspace's template. This approach shows a visual application icon in the dashboard. See the following `coder_app` example for a Node React app and note the `subdomain` and `share` settings:
```sh
# node app
resource "coder_app" "node-react-app" {
agent_id = coder_agent.dev.id
name = "node-react-app"
icon = "https://upload.wikimedia.org/wikipedia/commons/thumb/a/a7/React-icon.svg/2300px-React-icon.svg.png"
url = "http://localhost:3000"
subdomain = true
share = "authenticated"
healthcheck {
url = "http://localhost:3000/healthz"
interval = 10
threshold = 30
}
}
```
Valid `share` values include `owner` - private to the user, `authenticated` - accessible by any user authenticated to the Coder deployment, and `public` - accessible by users outside of the Coder deployment.
![Port forwarding from an app in the UI](../images/coderapp-port-forward.png)
## SSH
First, [configure SSH](../ides.md#ssh-configuration) on your