3.0 KiB
Development on a Remote Machine
Zulip can be developed on a remote server. We recommend doing this if you are running Windows or have other blockers stopping you from developing locally.
Connecting to the Remote Environment
Set up you remote server and connect to it.
We recommend using Mosh as it is more reliable over slow network connections.
Editing Code on the Remote Machine
You will need to either edit code locally on your computer and sync it to the remote development environment or just edit the zulip code base on the remote host.
Editing Locally
If you want to edit code locally you can install you favorite text editor:
Next, set up git on you local machine and clone the zulip repository.
Once you have your code locally you will need to sync your changes to your development server:
Editing Remotely
You will need to use a text editor on the remote machine:
Once you install an editor setup an ssh key on your host and clone the zulip repository.
Setting Up the Development Environment
- Installing on Ubuntu. This offers the most convenient developer experience, if you are developing on a clean remote machine we recomend this.
- Detailed tutorial for Vagrant development environment
- Brief installation instructions for Vagrant development environment
Running the Development Server
See Using the Development Environment.
Zulip will need to be run on an exposed interface so that you can access web server remotely.
./tools/run-dev.py --interface 0.0.0.0:9991
You can then navigate to http://<REMOTE_IP>:9991 and you should see something like (this screenshot of the Zulip dev environment).
You can port forward using ssh instead of running the dev env on an exposed interface.
Next Steps
At this point you should read about developing and read about using the development environment.