CMS Quickstarts¶
DDEV is ready to go with generic project types for PHP and Python frameworks, and more specific project types for working with popular platforms and CMSes. To learn more about how to manage projects in DDEV visit Managing Projects.
Before proceeding, make sure your installation of DDEV is up to date. In a new and empty project folder, using your favorite shell, run the following commands:
Backdrop¶
To get started with Backdrop, clone the project repository and navigate to the project directory.
You can start using DDEV with an existing project, too—but make sure you have a database backup handy!
# Clone an existing repository (or navigate to a local project directory):
git clone https://github.com/example/example-site my-backdrop-site
cd my-backdrop-site
# Set up the DDEV environment:
ddev config --project-type=backdrop
# Boot the project and install Composer packages (if required):
ddev start
ddev composer install
# Import a database backup and open the site in your browser:
ddev import-db --file=/path/to/db.sql.gz
ddev launch
CakePHP¶
You can start a new CakePHP project or configure an existing one.
The CakePHP project type can be used with any CakePHP project >= 3.x, but it has been fully tested with CakePHP 5.x. DDEV automatically creates the .env file with the database information, email transport configuration and a random salt. If .env file already exists, .env.ddev will be created, so you can take any variable and put it into your .env file.
Please note that you will need to change the PHP version to 7.4 to be able to work with CakePHP 3.x.
Craft CMS¶
Start a new Craft CMS project or retrofit an existing one.
Compatibility with Craft CMS 3
The craftcms project type is best with Craft CMS 4+, which is more opinionated about some settings. If you are using Craft CMS 3 or earlier, you may want to use the php project type and manage settings yourself.
Environment variables will be automatically added to your .env file to simplify the first boot of a project. For new installations, this means the default URL and database connection settings displayed during installation can be used without modification. If existing projects expect environment variables to be named in a particular way, you are welcome to rename them.
# Create a project directory and move into it:
mkdir my-craft-site && cd my-craft-site
# Set up the DDEV environment:
ddev config --project-type=craftcms --docroot=web
# Boot the project and install the starter project:
ddev start
ddev composer create craftcms/craft
ddev launch
Third-party starter projects can by used the same way—substitute the package name when running ddev composer create.
You can start using DDEV with an existing project, too—but make sure you have a database backup handy!
# Clone an existing repository (or navigate to a local project directory):
git clone https://github.com/example/example-site my-craft-site
cd my-craft-site
# Set up the DDEV environment:
ddev config --project-type=craftcms
# Boot the project and install Composer packages:
ddev start
ddev composer install
# Import a database backup and open the site in your browser:
ddev import-db --file=/path/to/db.sql.gz
ddev launch
Craft CMS projects use MySQL 8.0, by default. You can override this setting (and the PHP version) during setup with config command flags or after setup via the configuration files.
Upgrading or using a generic project type?
If you previously set up DDEV in a Craft project using the generic php project type, update the type: setting in .ddev/config.yaml to craftcms, then run ddev restart apply the changes.
Running Craft in a Subdirectory¶
In order for ddev craft to work when Craft is installed in a subdirectory, you will need to change the location of the craft executable by providing the CRAFT_CMD_ROOT environment variable to the web container. For example, if the installation lives in my-craft-site/app, you would run ddev config --web-environment-add=CRAFT_CMD_ROOT=./app. CRAFT_CMD_ROOT defaults to ./, the project root directory. Run ddev restart to apply the change.
Read more about customizing the environment and persisting configuration in Providing Custom Environment Variables to a Container.
Installing Craft
Read more about installing Craft in the official documentation.
Django 4 (Experimental)¶
git clone https://github.com/example/my-django-site
cd my-django-site
ddev config # Follow the prompts
# If your settings file is not `settings.py` you must add a DJANGO_SETTINGS_MODULE
ddev config --web-environment-add=DJANGO_SETTINGS_MODULE=<myapp.settings.local>
ddev start
# If your app requires setup, do it here:
# ddev python manage.py migrate
ddev launch
- DDEV will install everything in your
requirements.txtorpyproject.tomlinto avenv. This takes a little while on first startup. - DDEV appends a stanza to your settings file which includes the DDEV settings only if running in DDEV context.
- You can watch the
pip installin real time on that first slow startup withddev logs -fin another window. - If your
requirements.txtincludespsycopg2it requires build tools, so either setddev config --web-extra-packages=build-essentialor change your requirement topsycopg2-binary.
Drupal¶
For all versions of Drupal 8+ the Composer techniques work. The settings configuration is done differently for each Drupal version, but the project type is “drupal”.
mkdir my-drupal-site && cd my-drupal-site
ddev config --project-type=drupal --php-version=8.3 --docroot=web
ddev start
ddev composer create drupal/recommended-project:^10
ddev config --update
ddev composer require drush/drush
ddev drush site:install --account-name=admin --account-pass=admin -y
# use the one-time link (CTRL/CMD + Click) from the command below to edit your admin account details.
ddev drush uli
ddev launch
mkdir my-drupal-site && cd my-drupal-site
ddev config --project-type=drupal --php-version=8.3 --docroot=web
ddev start
ddev composer create drupal/recommended-project:^11.x-dev
ddev config --update
ddev restart
ddev composer require drush/drush
ddev drush site:install --account-name=admin --account-pass=admin -y
# use the one-time link (CTRL/CMD + Click) from the command below to edit your admin account details.
ddev drush uli
ddev launch
mkdir my-drupal-site && cd my-drupal-site
ddev config --project-type=drupal --php-version=8.1 --docroot=web
ddev start
ddev composer create drupal/recommended-project:^9
ddev config --update
ddev composer require drush/drush
ddev drush site:install --account-name=admin --account-pass=admin -y
# use the one-time link (CTRL/CMD + Click) from the command below to edit your admin account details.
ddev drush uli
ddev launch
git clone https://github.com/example/my-drupal-site
cd my-drupal-site
ddev config # Follow the prompts to select type and docroot
ddev start
ddev launch /install.php
Drupal 7 doesn’t know how to redirect from the front page to /install.php if the database is not set up but the settings files are set up, so launching with /install.php gets you started with an installation. You can also run drush site-install, then ddev exec drush site-install --yes.
See Importing a Database.
ExpressionEngine¶
mkdir my-ee-site && cd my-ee-site
# Download the zip archive for ExpressionEngine at https://github.com/ExpressionEngine/ExpressionEngine/releases/latest unarchive and move its content into the root of the my-ee-site directory
ddev config --database=mysql:8.0
ddev start
ddev launch /admin.php # Open installation wizard in browser
When the installation wizard prompts for database settings, enter db for the DB Server Address, DB Name, DB Username, and DB Password.
Visit your site.
Follow these steps based on the ExpressionEngine Git Repository README.md:
git clone https://github.com/ExpressionEngine/ExpressionEngine my-ee-site # for example
cd my-ee-site
ddev config # Accept the defaults
ddev start
ddev composer install
touch system/user/config/config.php
echo "EE_INSTALL_MODE=TRUE" >.env.php
ddev start
ddev launch /admin.php # Open installation wizard in browser
When the installation wizard prompts for database settings, enter db for the DB Server Address, DB Name, DB Username, and DB Password.
Grav¶
How to update?
Upgrade Grave core:
Update plugins and themes:
Visit the Grav Documentation for more information about Grav in general and visit Local Development with DDEV for more details about the usage of Grav with DDEV.
Ibexa DXP¶
Install Ibexa DXP OSS Edition.
mkdir my-ibexa-site && cd my-ibexa-site
ddev config --project-type=php --docroot=public --web-environment-add DATABASE_URL=mysql://db:db@db:3306/db
ddev start
ddev composer create ibexa/oss-skeleton
ddev exec console ibexa:install
ddev exec console ibexa:graphql:generate-schema
ddev launch /admin/login
In the web browser, log into your account using admin and publish.
Visit Ibexa documentation for more cases.
Kirby CMS¶
Start a new Kirby CMS project or use an existing one.
Create a new Kirby CMS project from the official Starterkit using DDEV’s composer create command:
# Create a new project directory and navigate into it
mkdir my-kirby-site && cd my-kirby-site
# Set up the DDEV environment
ddev config --omit-containers=db
# Spin up the project and install the Kirby Starterkit
ddev start
ddev composer create getkirby/starterkit
# Open the site in your browser
ddev launch
Installing Kirby
Read more about developing your Kirby project with DDEV in our extensive DDEV guide.
Laravel¶
Use a new or existing Composer project, or clone a Git repository.
The Laravel project type can be used for Lumen like it can for Laravel. DDEV automatically updates or creates the .env file with the database information.
Want to use a SQLite database for Laravel?
DDEV defaults to using a MariaDB database to better represent a production environment.
To select the Laravel 11 defaults for SQLite, use this command for ddev config:
Magento¶
Normal details of a Composer build for Magento 2 are on the Magento 2 site. You must have a public and private key to install from Magento’s repository. When prompted for “username” and “password” in composer create, it’s asking for your public key as “username” and private key as “password”.
Note that you can install the Adobe/Magento composer credentials in your global ~/.ddev/homeadditions/.composer/auth.json and never have to find them again. See In-Container Home Directory and Shell Configuration.
mkdir my-magento2-site && cd my-magento2-site
ddev config --project-type=magento2 --docroot=pub --disable-settings-management \
--upload-dirs=media --web-environment-add=COMPOSER_HOME="/var/www/html/.ddev/homeadditions/.composer"
ddev get ddev/ddev-elasticsearch
ddev start
ddev composer create --repository=https://repo.magento.com/ magento/project-community-edition
rm -f app/etc/env.php
echo "/auth.json" >.ddev/homeadditions/.composer/.gitignore
# Change the base-url below to your project's URL
ddev magento setup:install --base-url="https://my-magento2-site.ddev.site/" \
--cleanup-database --db-host=db --db-name=db --db-user=db --db-password=db \
--elasticsearch-host=elasticsearch --search-engine=elasticsearch7 --elasticsearch-port=9200 \
--admin-firstname=Magento --admin-lastname=User --admin-email=user@example.com \
--admin-user=admin --admin-password=Password123 --language=en_US
ddev magento deploy:mode:set developer
ddev magento module:disable Magento_TwoFactorAuth Magento_AdminAdobeImsTwoFactorAuth
ddev config --disable-settings-management=false
ddev php bin/magento info:adminuri
# Append the URI returned by the previous command either to ddev launch, like for example ddev launch /admin_XXXXXXX, or just run ddev launch and append the URI to the path in the browser
ddev launch
Change the admin name and related information as needed.
The admin login URL is specified by frontName in app/etc/env.php.
You may want to add the Magento 2 Sample Data with:
- Download OpenMage from release page.
- Make a directory for it, for example
mkdir ~/workspace/OpenMageand change to the new directorycd ~/workspace/OpenMage. - Run
ddev configand accept the defaults. - Install sample data. (See below.)
- Run
ddev start. - Follow the URL to the base site.
You may want the Magento 1 Sample Data for experimentation:
- Download Magento 1.9.2.4 Sample Data.
- Extract the download:
tar -zxf ~/Downloads/compressed-magento-sample-data-1.9.2.4.tgz --strip-components=1 - Import the example database
magento_sample_data_for_1.9.2.4.sqlwithddev import-db --file=magento_sample_data_for_1.9.2.4.sqlto database before running OpenMage install.
OpenMage is a huge codebase, and we recommend using Mutagen for performance on macOS and traditional Windows.
Moodle¶
mkdir my-moodle-site && cd my-moodle-site
ddev config --composer-root=public --docroot=public --webserver-type=apache-fpm
ddev start
ddev composer create moodle/moodle
ddev exec 'php public/admin/cli/install.php --non-interactive --agree-license --wwwroot=$DDEV_PRIMARY_URL --dbtype=mariadb --dbhost=db --dbname=db --dbuser=db --dbpass=db --fullname="DDEV Moodle Demo" --shortname=Demo --adminpass=password'
ddev launch /login
In the web browser, log into your account using admin and password.
Visit the Moodle Admin Quick Guide for more information.
Tip
Moodle relies on a periodic cron job—don’t forget to set that up! See ddev/ddev-cron.
Pimcore¶
Using the Pimcore skeleton repository:
mkdir my-pimcore-site && cd my-pimcore-site
ddev config --docroot=public
ddev start
ddev composer create pimcore/skeleton
ddev exec pimcore-install --mysql-username=db --mysql-password=db --mysql-host-socket=db --mysql-database=db --admin-password=admin --admin-username=admin --no-interaction
echo "web_extra_daemons:
- name: consumer
command: 'while true; do /var/www/html/bin/console messenger:consume pimcore_core pimcore_maintenance pimcore_scheduled_tasks pimcore_image_optimize pimcore_asset_update --memory-limit=250M --time-limit=3600; done'
directory: /var/www/html" >.ddev/config.pimcore.yaml
ddev start
ddev launch /admin
Python/Flask (Experimental)¶
git clone https://github.com/example/my-python-site
cd my-python-site
ddev config # Follow the prompts
# Tell gunicorn where your app is (WSGI_APP)
ddev config --web-environment-add=WSGI_APP=<my-app:app>
ddev start
# If you need to do setup before the site can go live, do it:
# ddev exec flask forge
ddev launch
- DDEV will install all everything in your
requirements.txtorpyproject.tomlinto avenv. This takes a little while on first startup. - If your app requires settings, you can add them as environment variables, or otherwise configure your app to use the database, etc. (Database settings are host:
db, database:db, user:db, passworddbno matter whether you’re using PostgreSQL, MariaDB, or MySQL.) - You can watch
pip installoutput in real time on that first slow startup withddev logs -fin another window. - If your
requirements.txtincludespsycopg2it requires build tools, so either setddev config --web-extra-packages=build-essentialor change your requirement topsycopg2-binary.
Shopware¶
Though you can set up a Shopware 6 environment many ways, we recommend the following technique. DDEV creates a .env.local file for you by default; if you already have one DDEV adds necessary information to it. When ddev composer create asks if you want to include Docker configuration, answer x, as this approach does not use their Docker configuration.
mkdir my-shopware-site && cd my-shopware-site
ddev config --project-type=shopware6 --docroot=public
ddev composer create shopware/production:^v6.5
# If it asks `Do you want to include Docker configuration from recipes?`
# answer `x`, as we're using DDEV for this rather than its recipes.
ddev exec console system:install --basic-setup
ddev launch /admin
# Default username and password are `admin` and `shopware`
Log into the admin site (/admin) using the web browser. The default credentials are username admin and password shopware. You can use the web UI to install sample data or accomplish many other tasks.
For more advanced tasks like adding elasticsearch, building and watching storefront and administration, see susi.dev.
Silverstripe¶
Use a new or existing Composer project, or clone a Git repository.
Your Silverstripe project is now ready. The CMS can be found at /admin, log into the default admin account using admin and password.
Visit the Silverstripe documentation for more information.
ddev sake can be used as a shorthand for the Silverstripe Make command ddev exec vendor/bin/sake
To open the CMS directly from CLI, run ddev launch /admin.
Statamic¶
Use a new or existing Composer project, or clone a Git repository.
The Laravel project type can be used for Statamic like it can for Laravel. DDEV automatically updates or creates the .env file with the database information.
Symfony¶
There are many ways to install Symfony, here are a few of them based on the Symfony docs.
If your project uses a database you’ll want to set the DB connection string in the .env. If using the default MariaDB configuration, you’ll want DATABASE_URL="mysql://db:db@db:3306/db?serverVersion=10.11". If you’re using a different database type or version, see ddev describe for the type and version.
TYPO3¶
WordPress¶
There are several easy ways to use DDEV with WordPress:
DDEV has built-in support for WP-CLI, the command-line interface for WordPress.
mkdir my-wp-site && cd my-wp-site
# Create a new DDEV project inside the newly-created folder
# (Primary URL automatically set to `https://<folder>.ddev.site`)
ddev config --project-type=wordpress
ddev start
# Download WordPress
ddev wp core download
# Launch in browser to finish installation
ddev launch
# OR use the following installation command
# (we need to use single quotes to get the primary site URL from `.ddev/config.yaml` as variable)
ddev wp core install --url='$DDEV_PRIMARY_URL' --title='New-WordPress' --admin_user=admin --admin_email=admin@example.com --prompt=admin_password
# Launch WordPress admin dashboard in your browser
ddev launch wp-admin/
Bedrock is a modern, Composer-based installation in WordPress:
mkdir my-wp-bedrock-site && cd my-wp-bedrock-site
ddev config --project-type=wordpress --docroot=web
ddev start
ddev composer create roots/bedrock
Rename the file .env.example to .env in the project root and make the following adjustments:
DB_NAME=db
DB_USER=db
DB_PASSWORD=db
DB_HOST=db
WP_HOME=${DDEV_PRIMARY_URL}
WP_SITEURL=${WP_HOME}/wp
WP_ENV=development
You can then run ddev start and ddev launch.
For more details, see Bedrock installation.
To get started using DDEV with an existing WordPress project, clone the project’s repository.
You’ll see a message like:
An existing user-managed wp-config.php file has been detected! Project DDEV settings have been written to:
/Users/rfay/workspace/bedrock/web/wp-config-ddev.php
Comment out any database connection settings in your wp-config.php file and add the following snippet to your wp-config.php, near the bottom of the file and before the include of wp-settings.php:
// Include for DDEV-managed settings in wp-config-ddev.php.
$ddev_settings = dirname(__FILE__) . '/wp-config-ddev.php';
if (is_readable($ddev_settings) && !defined('DB_USER')) {
require_once($ddev_settings);
}
If you don’t care about those settings, or config is managed elsewhere (like in a .env file), you can eliminate this message by adding a comment to wp-config.php:
Now run ddev start and continue importing a database if you need to.