ddev

README

ddev

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.

Roadmap

Each DRUD product has a dedicated product owner, who serves as the primary advocate for customers and end-users when making decisions regarding the public roadmap. For the ddev roadmap, @rickmanelius is currently serving as the product owner.

We use the longer-term roadmap to prioritize short-term sprints. Please review the ddev roadmap and ddev issue queue to see what's on the horizon.

System Requirements

• Docker version 17.05 or greater
• OS Support
  • macOS Sierra
  • Linux
    • Ubuntu 16.04 LTS
    • Debian Jessie
    • Fedora 25
  • Windows 10 Pro (experimental support!)
    • See Decisions and Plan for Linux & Windows Support for more information and the various options on getting ddev operational on Windows 10.

We are open to expanding this list to include additional OSs as well as improve our existing support for the ones listed above. Please let us know if you hit an issue!

Using ddev with other development environments

ddev requires ports 80 and 3306 to be available for use on your system when sites are running. If you are using another local development environment alongside ddev, please ensure the other environment is turned off or otherwise not using ports 80 and 3306.

If you need to use another environment after using ddev, simply ensure all of your ddev sites are stopped or removed. ddev only uses system ports when at least one site is running.

Installation

Homebrew - macOS

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

brew tap drud/ddev && brew install ddev

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

brew upgrade ddev

Installation Script - MacOS or Linux

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

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

Manual Installation - Linux and macOS

You can also easily perform the installation manually if preferred:

• Download and extract the latest ddev release for your architecture.
• Make ddev executable: chmod ugo+x ddev
• 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.

Manual Installation - Windows

• Download and extract the latest ddev release for Windows.
• Copy ddev.exe into %HOMEPATH%\AppData\Local\Microsoft\WindowsApps, or otherwise add ddev.exe to a folder defined in your PATH
• Run ddev from a Command Prompt or PowerShell to test your installation. You should see ddev's command usage output.

---

Usage

➜  ddev
This Command Line Interface (CLI) gives you the ability to interact with the ddev to create a local development environment.

Usage:
  ddev [command]

Available Commands:
  config       Create or modify a ddev application config in the current directory
  describe     Get a detailed description of a running ddev site.
  exec         Execute a Linux shell command in the webserver container.
  hostname     Manage your hostfile entries.
  import-db    Import the database of an existing site to the local dev environment.
  import-files Import the uploaded files directory of an existing site to the default public upload directory of your application.
  list         List applications that exist locally
  logs         Get the logs from your running services.
  restart      Restart the local development environment for a site.
  remove       Remove an application's local services.
  sequelpro    Easily connect local site to sequelpro
  ssh          SSH to an app container.
  start        Start the local development environment for a site.
  stop         Stop an application's local services.
  version      print ddev version and component versions

Use "ddev [command] --help" for more information about a command.

Getting Started - Documentation

Once you've installed ddev, check out the ddev Documentation Site for information on how to get started and how to use ddev.

Support

If you've encountered trouble using ddev, please use these resources to get help with your issue:

1. Please review the ddev Documentation to ensure your question isn't answered there.
2. Review the ddev issue queue to see if an issue similar to yours already exists.
3. If you've exhausted these options and still need help, please file an issue following the pre-populated guidelines and our Contributing Guidelines as best as possible.

Contributing

Interested in contributing to ddev? We would love your suggestions, contributions, and help! Please review our Guidelines for Contributing, then create an issue or open a pull request!