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

docs: Recommend Docker for all macOS users. 

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2021-09-17 18:42:56 -07:00 committed by Tim Abbott
parent 32c2ba8a7b
commit 6367384510
1 changed files with 6 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/development/setup-vagrant.md
View File

@ -4,9 +4,9 @@ This section guides first-time contributors through installing the
Zulip development environment on Windows, macOS, Ubuntu and Debian. Zulip development environment on Windows, macOS, Ubuntu and Debian.
The recommended method for installing the Zulip development environment is to use The recommended method for installing the Zulip development environment is to use
Vagrant with VirtualBox on Windows and macOS, and Vagrant with Docker on Vagrant with VirtualBox on Windows, and Vagrant with Docker on
Ubuntu. This method creates a virtual machine (for Windows and macOS) macOS and Ubuntu. This method creates a virtual machine (for Windows)
or a Linux container (for Ubuntu) inside which the Zulip server and or a Linux container (for macOS and Ubuntu) inside which the Zulip server and
all related services will run. all related services will run.
Contents: Contents:
@ -81,24 +81,11 @@ Jump to:
#### macOS #### macOS
##### Intel
1. Install [Vagrant][vagrant-dl] (latest). 1. Install [Vagrant][vagrant-dl] (latest).
2. Install [VirtualBox][vbox-dl] (latest). 2. Install [Docker Desktop](https://docs.docker.com/desktop/mac/install/) (latest).
(For a non-free option, but better performance, you can also use [VMware
Fusion][vmware-fusion-dl] with the [VMware Fusion Vagrant
plugin][vagrant-vmware-fusion-dl] or [Parallels Desktop][parallels-desktop-dl] as
a provider for Vagrant.)
Now you are ready for [Step 2: Get Zulip code](#step-2-get-zulip-code). Now you are ready for [Step 2: Get Zulip code](#step-2-get-zulip-code).
##### Apple Silicon
The setup for Apple Silicon (e.g. M1) Macs is very similar to that [for Intel
above](#intel), except that VirtualBox is not supported. Instead you can use [Docker for
Mac](https://docs.docker.com/docker-for-mac/install/).
#### Ubuntu #### Ubuntu
##### 1. Install Vagrant, Docker, and Git ##### 1. Install Vagrant, Docker, and Git
@ -285,12 +272,12 @@ Change into the zulip directory and tell vagrant to start the Zulip
development environment with `vagrant up`: development environment with `vagrant up`:
```bash ```bash
# On Windows or macOS (Intel): # On Windows:
cd zulip cd zulip
vagrant plugin install vagrant-vbguest vagrant plugin install vagrant-vbguest
vagrant up --provider=virtualbox vagrant up --provider=virtualbox
# On Linux or macOS (Apple Silicon): # On macOS or Linux:
cd zulip cd zulip
vagrant up --provider=docker vagrant up --provider=docker
``` ```
@ -1054,9 +1041,6 @@ remove the `GUEST_CPUS` and `GUEST_MEMORY_MB` lines from
[cygwin-dl]: https://cygwin.com/ [cygwin-dl]: https://cygwin.com/
[vagrant-dl]: https://www.vagrantup.com/downloads.html [vagrant-dl]: https://www.vagrantup.com/downloads.html
[vbox-dl]: https://www.virtualbox.org/wiki/Downloads [vbox-dl]: https://www.virtualbox.org/wiki/Downloads
[vmware-fusion-dl]: https://www.vmware.com/products/fusion.html
[vagrant-vmware-fusion-dl]: https://www.vagrantup.com/vmware/
[parallels-desktop-dl]: https://www.parallels.com/products/desktop/
[install-advanced]: ../development/setup-advanced.md [install-advanced]: ../development/setup-advanced.md
[rtd-git-guide]: ../git/index.md [rtd-git-guide]: ../git/index.md
[rtd-testing]: ../testing/testing.md [rtd-testing]: ../testing/testing.md