From 131c24b390ffd557ed98975eedf54829f48399d2 Mon Sep 17 00:00:00 2001 From: Karl Stolley Date: Thu, 4 Jan 2024 11:03:00 -0600 Subject: [PATCH] docs: Add warning about failed provisioning on macOS. Fixes: #28370 --- docs/development/setup-recommended.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/development/setup-recommended.md b/docs/development/setup-recommended.md index c99be173ec..4cee0d65e2 100644 --- a/docs/development/setup-recommended.md +++ b/docs/development/setup-recommended.md @@ -314,6 +314,16 @@ cd zulip vagrant up --provider=docker ``` +:::{warning} +There is a [known upstream issue on macOS](https://chat.zulip.org/#narrow/stream/21-provision-help/topic/provision.20error.20ERR_PNPM_LINKING_FAILED/near/1649241) +that can cause provisioning to fail with `ERR_PNPM_LINKING_FAILED` or other errors. The temporary +fix is to open the Docker desktop app's settings panel, and choose `osxfs (legacy)` under "Choose +file sharing implementation for your containers." Once Docker restarts, you should be able to +successfully run `vagrant up --provider=docker`. Back in Docker, you can return to using VirtioFS +for better system performance while developing, but you may need to revert to `osxfs (legacy)` +whenever you need to re-provision. +::: + The first time you run this command it will take some time because Vagrant does the following: