2016-09-21 19:31:51 +02:00
|
|
|
# Development environment installation
|
2015-11-04 05:57:54 +01:00
|
|
|
|
2016-11-28 01:56:24 +01:00
|
|
|
## Requirements
|
2016-10-11 02:10:39 +02:00
|
|
|
|
2016-11-29 23:23:54 +01:00
|
|
|
The Zulip development environment can be installed on **macOS,
|
2018-05-30 18:42:03 +02:00
|
|
|
Windows, and Linux** (Debian or Ubuntu recommended). You'll need at least **2GB
|
2016-11-29 23:23:54 +01:00
|
|
|
of available RAM**.
|
2016-10-11 02:10:39 +02:00
|
|
|
|
2016-11-29 23:23:54 +01:00
|
|
|
Installing the Zulip development environment requires downloading several hundred
|
2016-11-28 01:56:24 +01:00
|
|
|
megabytes of dependencies, so you will need an **active, reasonably fast,
|
|
|
|
|
internet connection throughout the entire installation processes.** You can
|
|
|
|
|
[configure a proxy][configure-proxy] if you need one.
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2016-11-28 02:50:33 +01:00
|
|
|
## Recommended setup (Vagrant)
|
2015-11-04 05:57:54 +01:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
**For first-time contributors, we recommend using the
|
|
|
|
|
[Vagrant development environment][install-vagrant]**.
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
This method creates a virtual machine (for Windows and macOS) or a
|
|
|
|
|
Linux container (otherwise) inside which the Zulip server and all
|
|
|
|
|
related services will run. Vagrant adds a bit of overhead to using the
|
|
|
|
|
Zulip development server, but provides an isolated environment that is
|
|
|
|
|
easy to install, update, and uninstall. It has been well-tested and
|
|
|
|
|
performs well.
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2016-11-28 02:50:33 +01:00
|
|
|
## Advanced setup (non-Vagrant)
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
Zulip also supports a wide range of ways to install the Zulip
|
|
|
|
|
development environment:
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2018-05-24 19:56:17 +02:00
|
|
|
* On **Ubuntu** 18.04 Bionic, 16.04 Xenial and 14.04 Trusty and **Debian** 9
|
2018-05-05 20:07:22 +02:00
|
|
|
Stretch, you can easily
|
|
|
|
|
**[install without using Vagrant][install-direct]**.
|
2019-03-10 01:23:43 +01:00
|
|
|
* On **other Linux/UNIX** distributions, you'll need to follow slightly different
|
2016-11-28 01:56:24 +01:00
|
|
|
instructions to **[install manually][install-generic]**.
|
|
|
|
|
* On **macOS and Linux** (Ubuntu recommended), you can install **[using
|
|
|
|
|
Docker][install-docker]**, though support for this remains experimental.
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2016-11-28 01:56:24 +01:00
|
|
|
Unfortunately, the only supported method to install on Windows is the [Vagrant
|
|
|
|
|
method][install-vagrant].
|
|
|
|
|
|
|
|
|
|
## Slow internet connections
|
|
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
If you have a very slow network connection, however, you may want to
|
|
|
|
|
avoid using Vagrant (which involves downloading an Ubuntu virtual
|
|
|
|
|
machine or Linux Container) and either
|
|
|
|
|
[install directly][install-direct] (recommended), or use
|
|
|
|
|
[the manual install process][install-generic] instead. These options
|
|
|
|
|
only support Linux.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
An alternative option if you have poor network connectivity is to rent
|
|
|
|
|
a cloud server and install the Zulip development environment for
|
|
|
|
|
remote use. See the [next section][self-install-remote] for details.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
|
|
|
|
## Installing remotely
|
|
|
|
|
|
2016-11-29 23:23:54 +01:00
|
|
|
The Zulip development environment works well on remote virtual
|
|
|
|
|
machines. This can be a good alternative for those with poor network
|
|
|
|
|
connectivity or who have limited storage/memory on their local
|
|
|
|
|
machines.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
We recommend giving the Zulip development environment its **own
|
|
|
|
|
virtual machine**, running one of
|
|
|
|
|
[the supported platforms for direct installation][install-direct],
|
|
|
|
|
with at least **2GB of memory**.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
2016-11-29 23:23:54 +01:00
|
|
|
If the Zulip development environment will be the only thing running on
|
|
|
|
|
the remote virtual machine, we recommend installing
|
|
|
|
|
[directly][install-direct]. Otherwise, we recommend the
|
|
|
|
|
[Vagrant][install-vagrant] method so you can easily uninstall if you
|
|
|
|
|
need to.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
|
|
|
|
## Next steps
|
2016-09-21 19:31:51 +02:00
|
|
|
|
|
|
|
|
Once you've installed the Zulip development environment, you'll want
|
|
|
|
|
to read these documents to learn how to use it:
|
|
|
|
|
|
2016-11-28 01:56:24 +01:00
|
|
|
* [Using the Development Environment][using-dev-env]
|
2018-12-10 17:12:58 +01:00
|
|
|
* [Testing][testing] (and [Configuring CI][ci])
|
2016-11-28 01:56:24 +01:00
|
|
|
|
2016-11-29 23:23:54 +01:00
|
|
|
And if you've setup the Zulip development environment on a remote
|
|
|
|
|
machine, take a look at our tips for
|
|
|
|
|
[developing remotely][dev-remote].
|
2016-05-05 01:16:31 +02:00
|
|
|
|
2019-03-06 17:57:27 +01:00
|
|
|
[dev-remote]: remote.md
|
|
|
|
|
[install-direct]: ../development/setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
|
|
|
|
[install-docker]: ../development/setup-advanced.md#using-docker-experimental
|
|
|
|
|
[install-generic]: ../development/setup-advanced.md#installing-manually-on-linux
|
|
|
|
|
[install-vagrant]: ../development/setup-vagrant.md
|
2016-11-28 01:56:24 +01:00
|
|
|
[self-install-remote]: #installing-remotely
|
|
|
|
|
[self-slow-internet]: #slow-internet-connections
|
2019-03-06 17:57:27 +01:00
|
|
|
[configure-proxy]: ../development/setup-vagrant.md#specifying-a-proxy
|
|
|
|
|
[using-dev-env]: using.md
|
|
|
|
|
[testing]: ../testing/testing.md
|
|
|
|
|
[ci]: ../git/cloning.md#step-3-configure-continuous-integration-for-your-fork
|
