Get Started

We’ll use OrbStack since it’s the most straightforward of several options.

1/4Install OrbStack Docker Provider

Launch OrbStack, accept the license agreement.

Confirm that you now have a Docker provider:

→ docker version

2/4Install DDEV

Confirm that you’ve now got DDEV installed: 🎉

→ ddev -v
ddev version v1.23.5

3/4Run mkcert -install

Running mkcert -install is a one-time operation. It allows your browser to trust the HTTPS/TLS certificates served by DDEV.

→ mkcert -install
Created a new local CA 💥
Sudo password:
The local CA is now installed in the system trust store! ⚡️
The local CA is now installed in the Firefox trust store (requires browser restart)! 🦊

4/4Create a Project

Navigate to a project you’d like to spin up with DDEV:

→ cd ~/dev/my-project

Initialize the project by running the ddev config command:

→ ddev config

Start the project for the first time. You’ll use the same command to start it later, too!

→ ddev start

If it’s a Composer project, you may also need to run ddev composer install.

Now run the launch command to open your project in a browser:

→ ddev launch

Explore & Enjoy!

Take a peek at your project’s new .ddev/ directory. You can add this to your repo to share your DDEV config, edit .ddev/config.yaml to change project options, or even go about your business and pretend this folder doesn’t exist.

Run the help command (or plain ddev) to see the actions you can take with the CLI:

→ ddev -h

Use the describe command to see a project’s parts and database connection details:

→ ddev describe

If you’re done working on a project and want to shut it down without removing anything, use the stop command:

→ ddev stop

If you were just kicking the tires and you want to permanently delete the project and its resources without touching your code, run the delete command:

→ ddev delete

DDEV will remove everything it created for the project and have no memory of its existence.

To uninstall DDEV, first clean up its Docker bits and delete its files from your system:

→ ddev clean --all
→ ddev hostname --remove-inactive
→ rm -r ~/.ddev
→ rm -r ~/.ddev_mutagen_data_directory

Then remove the ddev binary however you installed it:

→ brew uninstall ddev

→ rm /usr/local/bin/ddev

We’ll use WSL2 with Docker inside since it’s the fastest and most straightforward of several options.

1/3Install WSL2 with Ubuntu

Run the following in an administrative PowerShell v5 terminal:

> wsl --install

You’ll probably need to reboot.

Visit the Microsoft Store and install the updated “Windows Subsystem for Linux” and click “Open”. It will likely prompt you for a username and password for the Ubuntu WSL2 instance it creates.

Verify that you now have an Ubuntu distro set as default:

> wsl -l -v
  NAME                   STATE           VERSION
* Ubuntu                 Stopped         2

2/3Run the Install Script

Run the following in an administrative PowerShell:

> Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ddev/ddev/master/scripts/install_ddev_wsl2_docker_inside.ps1'))

In the “Ubuntu” terminal app or Windows Terminal, confirm that DDEV is installed: 🎉

$ ddev -v
ddev version v1.23.5

3/3Create a Project

Navigate to a project you’d like to spin up with DDEV:

$ cd ~/dev/my-project

Initialize the project by running the ddev config command:

$ ddev config

Start the project for the first time. You’ll use the same command to start it later, too!

$ ddev start

If it’s a Composer project, you may also need to run ddev composer install.

Now run the launch command to open your project in a browser:

$ ddev launch

Explore & Enjoy!

Take a peek at your project’s new .ddev/ directory. You can add this to your repo to share your DDEV config, edit .ddev/config.yaml to change project options, or even go about your business and pretend this folder doesn’t exist.

Run the help command (or plain ddev) to see the actions you can take with the CLI:

$ ddev -h

Use the describe command to see a project’s parts and database connection details:

$ ddev describe

If you’re done working on a project and want to shut it down without removing anything, use the stop command:

$ ddev stop

If you were just kicking the tires and you want to permanently delete the project and its resources without touching your code, run the delete command:

$ ddev delete

DDEV will remove everything it created for the project and have no memory of its existence.

To uninstall DDEV, first clean up its Docker bits and delete its files from your system:

$ ddev clean --all
$ ddev hostname --remove-inactive
$ rm -r ~/.ddev

Remove the ddev binary from the WSL2 distro:

$ sudo apt-get remove ddev

Lastly, remove DDEV from Windows by visiting Add or remove programs, finding “DDEV”, and choosing Uninstall.

We’ll install Docker and DDEV with your package manager, as detailed in the Linux installation docs.

1/4Install Docker

2/4Install DDEV

$ sudo sh -c 'echo ""'
$ sudo apt-get update && sudo apt-get install -y curl
$ sudo install -m 0755 -d /etc/apt/keyrings
$ curl -fsSL https://pkg.ddev.com/apt/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/ddev.gpg > /dev/null
$ sudo chmod a+r /etc/apt/keyrings/ddev.gpg
$ sudo sh -c 'echo ""'
$ echo "deb [signed-by=/etc/apt/keyrings/ddev.gpg] https://pkg.ddev.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list >/dev/null
$ sudo sh -c 'echo ""'
$ sudo apt-get update && sudo apt-get install -y ddev

$ sudo sh -c 'echo ""'
$ echo '[ddev]
name=ddev
baseurl=https://pkg.ddev.com/yum/
gpgcheck=0
enabled=1' | perl -p -e 's/^ +//' | sudo tee /etc/yum.repos.d/ddev.repo >/dev/null
$ sudo sh -c 'echo ""'
$ sudo dnf install --refresh ddev

$ yay -S ddev-bin

$ curl -fsSL https://ddev.com/install.sh | bash

Confirm that you’ve now got DDEV installed: 🎉

$ ddev -v
ddev version v1.23.5

3/4Run mkcert -install

Running mkcert -install is a one-time operation. It allows your browser to trust the HTTPS/TLS certificates served by DDEV.

$ mkcert -install
Created a new local CA 💥
The local CA is now installed in the system trust store! ⚡️
The local CA is now installed in the Firefox and/or Chrome/Chromium trust store (requires browser restart)! 🦊

4/4Create a Project

Navigate to a project you’d like to spin up with DDEV:

$ cd ~/dev/my-project

Initialize the project by running the ddev config command:

$ ddev config

Start the project for the first time. You’ll use the same command to start it later, too!

$ ddev start

If it’s a Composer project, you may also need to run ddev composer install.

Now run the launch command to open your project in a browser:

$ ddev launch

Explore & Enjoy!

Take a peek at your project’s new .ddev/ directory. You can add this to your repo to share your DDEV config, edit .ddev/config.yaml to change project options, or even go about your business and pretend this folder doesn’t exist.

Run the help command (or plain ddev) to see the actions you can take with the CLI:

$ ddev -h

Use the describe command to see a project’s parts and database connection details:

$ ddev describe

If you’re done working on a project and want to shut it down without removing anything, use the stop command:

$ ddev stop

If you were just kicking the tires and you want to permanently delete the project and its resources without touching your code, run the delete command:

$ ddev delete

DDEV will remove everything it created for the project and have no memory of its existence.

To uninstall DDEV, first clean up its Docker bits and delete its files from your system:

$ ddev clean --all
$ ddev hostname --remove-inactive
$ rm -r ~/.ddev

Then remove the ddev binary however you installed it:

$ sudo apt-get remove ddev

$ sudo dnf remove ddev

$ yay -R ddev-bin

$ sudo rm /usr/local/bin/ddev

1/2Launch a Provider & Install DDEV

Open any repository using Gitpod and install DDEV:

→ curl -fsSL https://pkg.ddev.com/apt/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/ddev.gpg > /dev/null
→ echo "deb [signed-by=/etc/apt/keyrings/ddev.gpg] https://pkg.ddev.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list >/dev/null
→ sudo apt-get update && sudo apt-get install -y ddev

1. Create a new codespace for your project or open an existing one.
2. Edit the project’s .devcontainer/devcontainer.json file:

   {
       "image": "mcr.microsoft.com/devcontainers/universal:2",
       "features": {
           "ghcr.io/ddev/ddev/install-ddev:latest": {}
       }
   }
   

3. Save the file and rebuild the container by running VS Code’s “Codespaces: Rebuild Container” action. (⌘ + SHIFT + P on a Mac or CTRL + SHIFT + P on Windows, then search for “rebuild”.)

Confirm that you’ve now got DDEV installed: 🎉

→ ddev -v
ddev version v1.23.5

Or use the ddev-gitpod-launcher form to launch a repository. You’ll provide a source repository and click a button to open a newly-established environment. You can specify a companion artifacts repository and automatically load db.sql.gz and files.tgz from it. (More details in the repository’s README.)

2/2Create a Project

Navigate to a project you’d like to spin up with DDEV:

→ cd ~/dev/my-project

Initialize the project by running the ddev config command:

→ ddev config

Start the project for the first time. You’ll use the same command to start it later, too!

→ ddev start

If it’s a Composer project, you may also need to run ddev composer install.

Now run the launch command to open your project in a browser:

→ ddev launch

Explore & Enjoy!

Take a peek at your project’s new .ddev/ directory. You can add this to your repo to share your DDEV config, edit .ddev/config.yaml to change project options, or even go about your business and pretend this folder doesn’t exist.

Run the help command (or plain ddev) to see the actions you can take with the CLI:

→ ddev -h

Use the describe command to see a project’s parts and database connection details:

→ ddev describe

If you’re done working on a project and want to shut it down without removing anything, use the stop command:

→ ddev stop

If you were just kicking the tires and you want to permanently delete the project and its resources without touching your code, run the delete command:

→ ddev delete

DDEV will remove everything it created for the project and have no memory of its existence.