Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.
This commit is contained in:
Scott Lee 2018-10-19 21:21:52 -07:00 committed by Tim Abbott
parent d69d71c59f
commit b4f95aa124
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/development/remote.md
View File

@ -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 <username>@<remote_server_ip> -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].

5
docs/development/setup-advanced.md
View File

@ -380,6 +380,10 @@ To start the development server:
… and visit <http://localhost:9991/>.
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