Skip to content

Commit c10eea1

Browse files
authored
[docs] Update guidance about Colima/Docker Desktop requirements and Mutagen (ddev#4694) [skip ci]
1 parent ffaa061 commit c10eea1

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

docs/content/index.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ These environments can be extended, version controlled, and shared, so you can t
2020
* RAM: 8GB
2121
* Storage: 256GB
2222
* [Colima](https://github.com/abiosoft/colima) or [Docker Desktop](https://www.docker.com/products/docker-desktop/)
23-
* Docker Desktop requires macOS Catalina (10.15) or higher; Colima runs on older systems
23+
* Colima and Docker Desktop both require macOS Big Sur (11) or higher.
24+
* On macOS with either Colima or Docker Desktop most users will want to enable Mutagen for best performance, `ddev config global --mutagen-enabled`
2425

2526
=== "Windows WSL2"
27+
2628
### Windows WSL2
2729

2830
* RAM: 8GB
@@ -48,8 +50,8 @@ These environments can be extended, version controlled, and shared, so you can t
4850
* RAM: 8GB
4951
* Storage: 256GB
5052

51-
=== "Gitpod"
53+
=== "Gitpod and GitHub Codespaces"
5254

53-
### Gitpod
55+
### Gitpod and GitHub Codespaces
5456

55-
With [Gitpod](https://www.gitpod.io) you don’t install anything; you only need a browser and an internet connection.
57+
With [Gitpod](https://www.gitpod.io) and [GitHub Codespaces](https://github.com/features/codespaces) you don’t install anything; you only need a browser and an internet connection.

docs/content/users/install/ddev-installation.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,11 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
4141
You can include a `-s <version>` argument to install a specific release or a prerelease version:
4242

4343
```
44-
curl -fsSL https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh | bash -s v1.19.5
44+
curl -fsSL https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh | bash -s v1.21.4
4545
```
4646

47+
We recommend [enabling Mutagen](performance.md#mutagen) for the best performance; enable with [`ddev config global --mutagen-enabled`](../usage/commands.md#config).
48+
4749
=== "Linux"
4850

4951
## Linux
@@ -173,7 +175,7 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
173175
You can do these things manually, or you can do most of it with the provided PowerShell (5) script.
174176
In all cases:
175177

176-
1. Install WSL2 with an Ubuntu distro. On a system without WSL2, just run:
178+
1. Install WSL2 with an Ubuntu distro. On a system without WSL2, run:
177179
```powershell
178180
wsl --install
179181
```
@@ -184,7 +186,7 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
184186

185187
If that doesn't work for you, see the [manual installation](https://docs.microsoft.com/en-us/windows/wsl/install-manual) and linked [troubleshooting](https://docs.microsoft.com/en-us/windows/wsl/troubleshooting#installation-issues).
186188
187-
If you prefer to use another Ubuntu distro, just install it and set it as default. For example, `wsl --set-default Ubuntu-22.04`.
189+
If you prefer to use another Ubuntu distro, install it and set it as default. For example, `wsl --set-default Ubuntu-22.04`.
188190

189191
2. Visit the Microsoft Store and install the updated "Windows Subsystem for Linux", then click *Open*. It will likely prompt you for a username and password for the Ubuntu WSL2 instance it creates.
190192

@@ -238,7 +240,7 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
238240
To upgrade DDEV in WSL2 Ubuntu, run `apt upgrade ddev` as described in the [Linux installation section](#linux).
239241

240242
!!!note "Path to certificates"
241-
If you get the prompt `Installing to the system store is not yet supported on this Linux`, you may just need to add `/usr/sbin` to the `$PATH` so that `/usr/sbin/update-ca-certificates` can be found.
243+
If you get the prompt `Installing to the system store is not yet supported on this Linux`, you may need to add `/usr/sbin` to the `$PATH` so that `/usr/sbin/update-ca-certificates` can be found.
242244

243245
### Traditional Windows
244246

@@ -247,6 +249,8 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
247249
* We recommend using [Chocolatey](https://chocolatey.org/). Once installed, you can run `choco install ddev docker-desktop git` from an administrative shell. You can upgrade by running `ddev poweroff && choco upgrade ddev`.
248250
* Each [DDEV release](https://github.com/drud/ddev/releases) includes a Windows installer (`ddev_windows_installer.<version>.exe`). After running that, you can open a new Git Bash, PowerShell, or cmd.exe window and start using DDEV.
249251

252+
Most traditional Windows users will want to enable Mutagen for superb performance; no installation is required; run `ddev config global --mutagen-enabled`. It still won't be as fast as one of the WSL2 options.
253+
250254
Most people interact with DDEV on Windows using Git Bash, part of the [Windows Git suite](https://git-scm.com/download/win). Although DDEV does work with cmd.exe and PowerShell, it's more at home in Bash. You can install Git Bash with Chocolatey by running `choco install -y git`.
251255

252256
!!!note "Windows Firefox Trusted CA"

docs/content/users/install/docker-installation.md

+2
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ You’ll need a Docker provider on your system before you can [install DDEV](dde
4949

5050
Docker Desktop for Mac can be installed via Homebrew (`brew install homebrew/cask/docker`) or can be downloaded from [docker.com](https://www.docker.com/products/docker-desktop). It has long been supported by DDEV and has extensive automated testing.
5151

52+
We do not recommend the `VirtioFS` option with Docker Desktop for Mac. While it’s performant, it can cause mysterious problems that are not present with [Mutagen](performance.md#mutagen)—which offers comparable performance when enabled.
53+
5254
=== "Windows"
5355

5456
## Windows

0 commit comments

Comments
 (0)