{"id":16625,"date":"2019-09-03T08:41:59","date_gmt":"2019-09-03T08:41:59","guid":{"rendered":"https:\/\/www.mautic.org\/local-mautic-development-with-ddev\/"},"modified":"2024-12-18T11:49:40","modified_gmt":"2024-12-18T11:49:40","slug":"local-mautic-development-with-ddev","status":"publish","type":"post","link":"https:\/\/mautic.org\/blog\/local-mautic-development-with-ddev","title":{"rendered":"Local Mautic development with DDEV"},"content":{"rendered":"\r\n

DDEV<\/a> is an OS agnostic wrapper for Docker that makes it easy to set up PHP projects on your local machine. DDEV aims to make Docker simple and accessible to everyone. Even better, DDEV is entirely open source.<\/p>\r\n\r\n\r\n

In this guide we will show you how to set up a local development environment for Mautic, using DDEV.<\/p>\r\n\r\n\r\n

Installing Docker and DDEV<\/h2>\r\n\r\n\r\n

Before we can get started you will need to install Docker and Docker Compose. You can find documentation on how to correctly do this here<\/a>.<\/p>\r\n\r\n\r\n

Once those are installed we can continue with installing DDEV. You can find installation instructions for Linux, MacOS and Windows here<\/a>.<\/p>\r\n\r\n\r\n

Installing Mautic<\/h2>\r\n\r\n\r\n

Clone the Mautic repository into a folder of your choice. Once that is done make sure to install the Composer dependencies with composer install.<\/p>\r\n\r\n\r\n

Starting DDEV and configuring Mautic<\/h2>\r\n\r\n\r\n

Use the command line and navigate to the root of your Mautic installation.\u00a0Once there, run\u00a0<\/p>\r\n\r\n\r\n

\r\nddev config<\/pre>\r\n\r\n\r\n
It will ask you for a project name – you can leave it at the default, or give it a custom name. This is really up to you. For the purposes of this example, we will name this project mautic.<\/p>\r\n\r\n\r\n
Next it will ask for the docroot of the project.<\/p>\r\n\r\n\r\n
Since the index.php of Mautic is located in the root folder of the project, we can just go with the default value. Simply press enter.<\/p>\r\n\r\n\r\n
After this it will ask for the project type. Enter php and hit enter again.<\/p>\r\n\r\n\r\n
Everything should now be configured. We just need to change one more thing! Go to .ddev\/config.yaml and you’ll find something similar to:<\/p>\r\n\r\n
\r\nAPIVersion: v1.13.1\r\nname: demodir\r\ntype: php\r\ndocroot: \"\"\r\nphp_version: \"7.3\"\r\nwebserver_type: nginx-fpm\r\nrouter_http_port: \"80\"\r\nrouter_https_port: \"443\"\r\nxdebug_enabled: false\r\nadditional_hostnames: []\r\nadditional_fqdns: []\r\nnfs_mount_enabled: false\r\nprovider: default\r\nuse_dns_when_possible: true\r\ntimezone: \"\"<\/code><\/pre>\r\n\r\n\r\n
… change the webserver type to\u00a0the following:<\/p>\r\n\r\n
\r\nwebserver_type: apache-fpm<\/code><\/pre>\r\n\r\n
… add the following row (make sure to replace 7.3 with whichever PHP version you’re using!<\/strong>):<\/p>\r\n\r\n
\r\nwebimage_extra_packages: [php7.3-imap]<\/code><\/pre>\r\n\r\n
… and change the timezone to whichever timezone you’re in, for example:<\/p>\r\n\r\n
\r\ntimezone: \"Europe\/Amsterdam\"<\/code><\/pre>\r\n\r\n
… you’ll have the following config.yaml file then:<\/p>\r\n\r\n
\r\nAPIVersion: v1.13.1\r\nname: mautic\r\ntype: php\r\ndocroot: \"\"\r\nphp_version: \"7.3\"\r\nwebserver_type: apache-cgi\r\nrouter_http_port: \"80\"\r\nrouter_https_port: \"443\"\r\nxdebug_enabled: false\r\nadditional_hostnames: []\r\nadditional_fqdns: []\r\nnfs_mount_enabled: false\r\nprovider: default\r\nuse_dns_when_possible: true\r\ntimezone: \"Europe\/Amsterdam\"\r\nwebimage_extra_packages: [php7.3-imap]<\/code><\/pre>\r\n\r\n
Note: if you have Apache2 or nginx installed, and they are currently using port 80, ensure that you shut them down or change their ports before starting the DDEV instance. If you do not follow this step, starting will fail with an error message telling you that port 80 is already in use.<\/em><\/p>\r\n\r\n\r\n
You can start DDEV by running\u00a0<\/p>\r\n\r\n\r\n
\r\nddev start\u00a0<\/pre>\r\n\r\n\r\n
on the command line.\u00a0<\/p>\r\n\r\n\r\n
If this is your first DDEV instance this can take a bit of time to initialise, as it will need to pull all the containers.\u00a0<\/p>\r\n\r\n
If you cloned Mautic from GitHub, you need to run composer install in order to get started. Run<\/strong><\/p>\r\n\r\n
\r\nddev ssh\r\ncomposer install<\/pre>\r\n\r\n
… and you should be good to go.<\/strong><\/p>\r\n\r\n\r\n
Once started you will find your project at mautic.ddev.site (in case you used a different project name it will be yourprojectname.ddev.site).<\/p>\r\n\r\n\r\n
Navigating there in the browser should bring up the Mautic installation. Make sure that during the installation you use the following settings:<\/p>\r\n\r\n\r\n