From 8d4b6086f619ad9f92407ae377be9d8249127963 Mon Sep 17 00:00:00 2001
From: mark-theshark <mtm20176@gmail.com>
Date: Sun, 7 Aug 2022 16:30:15 -0500
Subject: [PATCH] chore: docs: add port-forwarding options (CLI & ssh) (#3394)

* chore: docs: add port-forwarding options

* fix: code type

Co-authored-by: Eric Paulsen <eric@Erics-MacBook-Air.local>
---
 docs/ides.md                             |  7 +++++
 docs/ides/configuring-port-forwarding.md | 34 ++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 docs/ides/configuring-port-forwarding.md

diff --git a/docs/ides.md b/docs/ides.md
index 9fd570db94..59cfb970fa 100644
--- a/docs/ides.md
+++ b/docs/ides.md
@@ -78,3 +78,10 @@ Connection and connect to your Coder workspace.](./ides/configuring-gateway.md)
 ## Web IDEs (Jupyter, code-server, JetBrains Projector)
 
 Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./ides/configuring-web-ides.md).
+
+## Port Forwarding
+
+Port Forwarding lets developers securely access processes on their Coder
+workspace from a local machine. A common use case is testing front-end
+applications in a browser at `http://localhost:<yourforwardedport>` See
+[configuring Port Forwarding](./ides/configuring-port-forwarding.md).
diff --git a/docs/ides/configuring-port-forwarding.md b/docs/ides/configuring-port-forwarding.md
new file mode 100644
index 0000000000..bda25b1f97
--- /dev/null
+++ b/docs/ides/configuring-port-forwarding.md
@@ -0,0 +1,34 @@
+# Configuring Port Forwarding
+
+There are two ways to forward ports:
+
+- The Coder CLI port-forward command
+- SSH
+
+## The Coder CLI and port-forward
+
+For example:
+
+```console
+coder port-forward mycoderworkspacename --tcp 8000:8000
+```
+
+For more examples, type `coder port-forward --help`
+
+## SSH
+
+Use the Coder CLI to first [configure SSH](../ides.md#ssh-configuration) on your
+local machine. Then run `ssh`. For example:
+
+```console
+ssh -L 8000:localhost:8000 coder.mycoderworkspacename 
+```
+
+## Accessing the forwarded port
+
+After completing either Port Forwarding method, open a web browser on your local
+machine to access the Coder workspace process.
+
+```console
+http://localhost:<yourforwardedport>
+```