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
|
|
|
|
2021-11-15 05:21:40 +01:00
|
|
|
## Recommended setup
|
2015-11-04 05:57:54 +01:00
|
|
|
|
2018-05-30 18:42:03 +02:00
|
|
|
**For first-time contributors, we recommend using the
|
2021-11-15 05:21:40 +01:00
|
|
|
[Vagrant development environment][install-vagrant]** on
|
|
|
|
|
macOS and Linux based OS and [WSL 2 setup][install-via-wsl] on Windows.
|
2016-09-21 19:31:51 +02:00
|
|
|
|
2021-11-15 05:21:40 +01:00
|
|
|
## Vagrant setup
|
|
|
|
|
|
|
|
|
|
[Vagrant setup][install-vagrant] creates a virtual machine (for Windows and macOS) or a
|
2018-05-30 18:42:03 +02:00
|
|
|
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
|
|
|
|
2021-04-14 06:23:26 +02:00
|
|
|
## Advanced setup
|
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
|
|
|
|
2021-08-20 21:45:39 +02:00
|
|
|
- On Linux platforms, you can **[install directly][install-direct]**.
|
|
|
|
|
- On Windows, you can **[install directly][install-via-wsl]** via WSL 2.
|
2016-11-28 01:56:24 +01:00
|
|
|
|
|
|
|
|
## 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
|
2021-04-14 06:23:26 +02:00
|
|
|
machine or Linux container) and [install directly][install-direct] on
|
|
|
|
|
a Linux system.
|
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:
|
|
|
|
|
|
2021-08-20 21:45:39 +02:00
|
|
|
- [Using the development environment][using-dev-env]
|
|
|
|
|
- [Testing][testing] (and [Configuring CI][ci])
|
2016-11-28 01:56:24 +01:00
|
|
|
|
2020-08-11 01:47:54 +02:00
|
|
|
And if you've set up the Zulip development environment on a remote
|
2016-11-29 23:23:54 +01:00
|
|
|
machine, take a look at our tips for
|
|
|
|
|
[developing remotely][dev-remote].
|
2016-05-05 01:16:31 +02:00
|
|
|
|
2019-09-30 19:37:56 +02:00
|
|
|
[dev-remote]: remote.md
|
2022-02-16 01:39:15 +01:00
|
|
|
[install-direct]: setup-advanced.md#installing-directly-on-ubuntu-debian-centos-or-fedora
|
2022-09-10 02:31:23 +02:00
|
|
|
[install-vagrant]: setup-recommended.md
|
2016-11-28 01:56:24 +01:00
|
|
|
[self-install-remote]: #installing-remotely
|
|
|
|
|
[self-slow-internet]: #slow-internet-connections
|
2022-09-10 02:31:23 +02:00
|
|
|
[configure-proxy]: setup-recommended.md#specifying-a-proxy
|
2019-09-30 19:37:56 +02:00
|
|
|
[using-dev-env]: using.md
|
|
|
|
|
[testing]: ../testing/testing.md
|
2022-02-16 01:39:15 +01:00
|
|
|
[ci]: ../git/cloning.md#step-3-configure-continuous-integration-for-your-fork
|
2023-06-09 01:12:49 +02:00
|
|
|
[install-via-wsl]: setup-recommended.md#windows-10-or-11
|
