From b4f95aa12420f11afd383746af3ecee0803e4ee3 Mon Sep 17 00:00:00 2001 From: Scott Lee Date: Fri, 19 Oct 2018 21:21:52 -0700 Subject: [PATCH] doc: Expand documentation for SSH port forwarding. This adds additional links and examples to make it much more clear how to do secure SSH port-forwarding with a remote development environment. --- docs/development/remote.md | 21 ++++++++++++++++----- docs/development/setup-advanced.md | 5 +++++ 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/docs/development/remote.md b/docs/development/remote.md index df695ea279..93ea9968a9 100644 --- a/docs/development/remote.md +++ b/docs/development/remote.md @@ -84,14 +84,25 @@ this screenshot of the Zulip development environment: ![Image of Zulip development environment](../images/zulip-dev.png) -The `--interface=''` command makes the Zulip development environment -accessible from any IP address (in contrast with the more secure +The `--interface=''` option makes the Zulip development environment +accessible from any IP address (in contrast with the much more secure default of only being accessible from localhost, which is great for developing on your laptop). -You can [port -forward](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding) using -ssh instead of running the development environment on an exposed interface. +To properly secure your remote development environment, you can +[port forward](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding) +using ssh instead of running the development environment on an exposed +interface. For example, if you're running Zulip on a remote server +such as a DigitalOcean Droplet or an AWS EC2 instance, you can setup +port-forwarding to access Zulip by running the following command in +your terminal: + +``` +ssh -L 3000:127.0.0.1:9991 @ -N +``` + +Now you can access Zulip by navigating to `http://127.0.0.1:3000` in +your local computer's browser. For more information, see [Using the development environment][rtd-using-dev-env]. diff --git a/docs/development/setup-advanced.md b/docs/development/setup-advanced.md index f678d576ac..c5f9955491 100644 --- a/docs/development/setup-advanced.md +++ b/docs/development/setup-advanced.md @@ -380,6 +380,10 @@ To start the development server: … and visit . +If you're running your development server on a remote server, look at +[the remote development docs][port-forward-setup] for port forwarding +advice. + #### Proxy setup for by-hand installation If you are building the development environment on a network where a @@ -552,3 +556,4 @@ guide and the Docker tooling if you are using Docker to develop Zulip! [zulip-rtd-git-cloning]: ../git/cloning.html#step-1b-clone-to-your-machine [zulip-rtd-git-connect]: ../git/cloning.html#step-1c-connect-your-fork-to-zulip-upstream +[port-forward-setup]: ../development/remote.html#running-the-development-server