docs: Update remote development documentation to be more accurate.

I have updated the remote development documentations to be more accurate
when it comes to developing on a Zulip Development Droplet to ensure
the user knows to access at `zulip.username.zulipdev.org`.
This commit is contained in:
Adam Birds
2021-04-16 02:35:15 +00:00
committed by Tim Abbott
parent 82106faf6c
commit 0cf3e0c226
2 changed files with 14 additions and 8 deletions

View File

@@ -58,13 +58,16 @@ the remote virtual machine, we recommend installing
need to. need to.
The main difference from the standard instructions is that for a The main difference from the standard instructions is that for a
remote development environment, you'll need to run `export remote development environment, and you're not using our Digital Ocean
EXTERNAL_HOST=<REMOTE_IP>:9991` in a shell before running `run-dev.py` Droplet infrastructure (which handles `EXTERNAL_HOST` for you), you'll
(and see also the `--interface=''` option documented below). If your need to run `export EXTERNAL_HOST=<REMOTE_IP>:9991` in a shell before
server has a static IP address, we recommend putting this command in running `run-dev.py` (and see also the `--interface=''` option
`~/.bashrc`, so you don't need to remember to run it every time. This documented below).
allows you to access Zulip running in your development environment
using a browser on another host. If your server has a static IP address, we recommend putting this
command in `~/.bashrc`, so you don't need to remember to run it every
time. This allows you to access Zulip running in your development
environment using a browser on another host.
## Running the development server ## Running the development server

View File

@@ -63,7 +63,10 @@ Once your remote dev instance is ready:
- Once you log in, you should see `(zulip-py3-venv) ~$`. - Once you log in, you should see `(zulip-py3-venv) ~$`.
- To start the dev server, `cd zulip` and then run `./tools/run-dev.py`. - To start the dev server, `cd zulip` and then run `./tools/run-dev.py`.
- While the dev server is running, you can see the Zulip server in your browser - While the dev server is running, you can see the Zulip server in your browser
at http://username.zulipdev.org:9991. at http://zulip.username.zulipdev.org:9991.
- The development server actually runs on all subdomains of
`username.zulipdev.org`; this is important for testing Zulip's
support for multiple organizations in your development server.
Once you've confirmed you can connect to your remote server, take a look at: Once you've confirmed you can connect to your remote server, take a look at: