opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: Support for comma-separation and ranges in port-forward (#4166)

Browse Source 
Fixes #3766
This commit is contained in:
Mathias Fredriksson
2022-10-03 11:58:43 +03:00
committed by GitHub
parent 4919975f13
commit 092a22f242
3 changed files with 207 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/networking/port-forwarding.md
+22 -2
View File
@@ -12,14 +12,34 @@ There are three ways to forward ports in Coder:
The `coder port-forward` command is generally more performant.
## coder port-forward
## The `coder port-forward` command
Forward the remote TCP port `8080` to local port `8000` like so:
This command can be used to forward TCP or UDP ports from the remote
workspace so they can be accessed locally. Both the TCP and UDP command
line flags (`--tcp` and `--udp`) can be given once or multiple times.
The supported syntax variations for the `--tcp` and `--udp` flag are:
- Single port with optional remote port: `local_port[:remote_port]`
- Comma separation `local_port1,local_port2`
- Port ranges `start_port-end_port`
- Any combination of the above
### Examples
Forward the remote TCP port `8080` to local port `8000`:
```console
coder port-forward myworkspace --tcp 8000:8080
```
Forward the remote TCP port `3000` and all ports from `9990` to `9999`
to their respective local ports.
```console
coder port-forward myworkspace --tcp 3000,9990-9999
```
For more examples, see `coder port-forward --help`.
## Dashboard