Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 5.15 KB

index.md

File metadata and controls

82 lines (52 loc) · 5.15 KB
Raw

ddev Documentation

ddev is an open source tool that makes it dead simple to get local PHP development environments up and running within minutes. It's powerful and flexible as a result of its per-project environment configurations, which can be extended, version controlled, and shared. In short, ddev aims to allow development teams to use Docker in their workflow without the complexities of bespoke configuration.

System Requirements

  • Docker version 18.06 or higher. Linux users make sure you do the post-install steps
  • docker-compose 1.20.0 and higher (bundled with Docker in Docker for Mac and Docker for Windows)
  • OS Support
    • macOS Sierra and higher (macOS 10.12 and higher but it should runs anywhere docker-ce runs)
    • Linux: Most recent Linux distributions which can run Docker-ce are fine. This includes at least Ubuntu 14.04+, Debian Jessie+, Fedora 25+. Make sure to follow the docker-ce post-install steps
    • Windows 10 Pro or Enterprise with Docker-for-windows
    • Windows 10 Home (or other Windows version) with Docker Toolbox

Using ddev with other development environments

ddev by default uses ports 80 and 443 on your system when projects are running. If you are using another local development environment you can either stop the other environment or configure ddev to use different ports. See troubleshooting for more detailed problemsolving.

Installation

When upgrading, please check the release notes for actions you might need to take on each project.

Docker Installation

Docker and docker-compose are required before anything will work with ddev. This is pretty easy on most environments, but we have a docker_installation page to help sort out the nuances, especially on Windows and Linux.

Homebrew - macOS

For macOS users, we recommend downloading, installing, and upgrading via homebrew:

brew tap drud/ddev && brew install ddev

Later, to upgrade to a newer version of ddev, run:

brew upgrade ddev

Installation or Upgrade - Windows

  • A windows installer is provided in each ddev release (ddev_windows_installer.<version>.exe). Run that and it will do the full installation for you. If you get a Windows Defender Smartscreen warning "Windows protected your PC", click "More info" and then "Run anyway". Open a new terminal or cmd window and start using ddev.
  • If using Docker Toolbox (on WIndows 10 Home, for example):
    • Start Docker Toolbox by running the Docker Quickstart Terminal.
    • Execute ddev commands within the Docker Quickstart Terminal.

Installation/Upgrade Script - Linux and macOS

Linux and macOS end-users can use this line of code to your terminal to download, verify, and install (or upgrade) ddev using our install script:

curl -L https://raw.githubusercontent.com/drud/ddev/master/install_ddev.sh | bash

Later, to upgrade ddev to the latest version, just run this again.

Manual Installation or Upgrade - Linux and macOS

You can also easily perform the installation or upgrade manually if preferred. ddev is just a single executable, no special installation is actually required, so for all operating systems, the installation is just copying ddev into place where it's in the system path.

  • Download and extract the latest ddev release for your architecture.
  • Move ddev to /usr/local/bin: mv ddev /usr/local/bin/ (may require sudo), or another directory in your $PATH as preferred.
  • Run ddev to test your installation. You should see ddev's command usage output.

Installation via package managers - Linux

Some Linux distributions may package ddev in a way that's convenient for your distro. Right now, we are aware of packages for the following distros:

* [Arch Linux (AUR)](https://aur.archlinux.org/packages/ddev-bin/)

Note that third party packaging is encouraged, but only supported on a best-effort basis.

Versioning

The DDEV project is committed to supporting Semantic Version 2.0.0. Additional context on this decision can be read in Ensure ddev is properly utilizing Semantic Versioning.

Support