feat: Add port forward button (#4167)

This commit is contained in:
Bruno Quaresma
2022-09-26 14:56:17 +00:00
committed by GitHub
parent 413bfb8d58
commit c37ecdb9ff
11 changed files with 248 additions and 6 deletions
+9
View File
@@ -14,6 +14,15 @@ should not be localhost.
> Access URL should be a external IP address or domain with DNS records pointing to Coder.
## Wildcard access URL
`CODER_WILDCARD_ACCESS_URL` is necessary for [port forwarding](../networking/port-forwarding.md#dashboard)
via the dashboard or running [coder_apps](../templates.md#coder-apps) on an absolute path. Set this to a wildcard
subdomain that resolves to Coder (e.g. `*.coder.example.com`).
> If you are providing TLS certificates directly to the Coder server, you must use a single certificate for the
> root and wildcard domains. Multi-certificate support [is planned](https://github.com/coder/coder/pull/4150).
## PostgreSQL Database
Coder uses a PostgreSQL database to store users, workspace metadata, and other deployment information.
Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

+5 -1
View File
@@ -1,5 +1,9 @@
{
"versions": ["main", "v0.8.1", "v0.7.12"],
"versions": [
"main",
"v0.8.1",
"v0.7.12"
],
"routes": [
{
"title": "About",
+12 -1
View File
@@ -4,9 +4,10 @@ Port forwarding lets developers securely access processes on their Coder
workspace from a local machine. A common use case is testing web
applications in a browser.
There are two ways to forward ports in Coder:
There are three ways to forward ports in Coder:
- The `coder port-forward` command
- Dashboard
- SSH
The `coder port-forward` command is generally more performant.
@@ -21,6 +22,16 @@ coder port-forward myworkspace --tcp 8000:8080
For more examples, see `coder port-forward --help`.
## Dashboard
> To enable port forwarding via the dashboard, Coder must be configured with a
> [wildcard access URL](./admin/configure#wildcard-access-url).
Use the "Port forward" button in the dashboard to access ports
running on your workspace.
![Port forwarding in the UI](../images/port-forward-dashboard.png)
## SSH
First, [configure SSH](../ides.md#ssh-configuration) on your