Drupal Development VM

http://www.drupalvm.com/

For Drupal 6, 7, 8, etc.

This project aims to make spinning up a simple local Drupal test/development environment incredibly quick and easy, and to introduce new developers to the wonderful world of Drupal development on local virtual machines (instead of crufty old MAMP/WAMP-based development).

It will install the following on an Ubuntu 14.04 (by default) linux VM:

Apache 2.4.x
PHP 5.5.x (configurable)
MySQL 5.5.x
Drush (configurable)
Drupal Console (if using Drupal 8+)
Drupal 6.x, 7.x, or 8.x.x (configurable)
Optional (installed by default):
- Apache Solr 4.10.x (configurable)
- Memcached
- XHProf, for profiling your code
- XDebug, for debugging your code
- PHPMyAdmin, for accessing databases directly
- Pimp my Log, for easy viewing of log files
- MailHog, for catching and debugging email

It should take 5-10 minutes to build or rebuild the VM from scratch on a decent broadband connection.

Please read through the rest of this README and the Drupal VM Wiki for help getting Drupal VM configured and integrated with your development workflow.

Customizing the VM

There are a couple places where you can customize the VM for your needs:

config.yml: Contains variables like the VM domain name and IP address, PHP and MySQL configuration, etc.
drupal.make.yml: Contains configuration for the Drupal core version, modules, and patches that will be downloaded on Drupal's initial installation (more about Drush make files).

If you want to switch from Drupal 8 (default) to Drupal 7 or 6 on the initial install, do the following:

Update the Drupal version and core inside the drupal.make.yml file.
Update drupal_major_version inside config.yml.

Quick Start Guide

This Quick Start Guide will help you quickly build a Drupal 8 site on the Drupal VM using the included example Drush make file. You can also use the Drupal VM with a Local Drupal codebase or even a Drupal multisite installation.

1 - Install dependencies (VirtualBox, Vagrant, Ansible)

Download and install VirtualBox (Drupal VM also works with Parallels or VMware, if you have the Vagrant VMware integration plugin).
Download and install Vagrant.
[Mac/Linux only] Install Ansible.

Note for Windows users: Ansible will be installed inside the VM, and everything will be configured internally (unlike on Mac/Linux hosts). See JJG-Ansible-Windows for more information.

Note for Linux users: If NFS is not already installed on your host, you will need to install it to use the default NFS synced folder configuration. See guides for Debian/Ubuntu, Arch, and RHEL/CentOS.

2 - Build the Virtual Machine

Download this project and put it wherever you want.
Make copies of both of the example.* files, and modify to your liking: - Copy example.drupal.make.yml to drupal.make.yml. - Copy example.config.yml to config.yml.
Create a local directory where Drupal will be installed and configure the path to that directory in config.yml (local_path, inside vagrant_synced_folders).
Open Terminal, cd to this directory (containing the Vagrantfile and this README file).
[Mac/Linux only] Install Ansible Galaxy roles required for this VM: $ sudo ansible-galaxy install -r provisioning/requirements.txt
Type in vagrant up, and let Vagrant do its magic.

Note: If there are any errors during the course of running vagrant up, and it drops you back to your command prompt, just run vagrant provision to continue building the VM from where you left off. If there are still errors after doing this a few times, post an issue to this project's issue queue on GitHub with the error.

3 - Configure your host machine to access the VM.

Edit your hosts file, adding the line 192.168.88.88 drupalvm.dev so you can connect to the VM. Alternatively, you can install a Vagrant plugin to automatically add and remove the entry from your hosts file; run vagrant plugin install vagrant-hostsupdater. The plugin will also add in all other hosts defined via apache_vhosts.
Open your browser and access http://drupalvm.dev/. The default login for the admin account is admin for both the username and password.

Extra software/utilities

By default, this VM includes the extras listed in the config.yml option installed_extras:

installed_extras:
  - mailhog
  - memcached
  - phpmyadmin
  - solr
  - xdebug
  - xhprof

If you don't want or need one or more of these extras, just delete them or comment them from the list. This is helpful if you want to reduce PHP memory usage or otherwise conserve system resources.

Using Drupal VM

Drupal VM is built to integrate with every developer's workflow. Many guides for using Drupal VM for common development tasks are available on the Drupal VM Wiki:

Other Notes

To shut down the virtual machine, enter vagrant halt in the Terminal in the same folder that has the Vagrantfile. To destroy it completely (if you want to save a little disk space, or want to rebuild it from scratch with vagrant up again), type in vagrant destroy.
When you rebuild the VM (e.g. vagrant destroy and then another vagrant up), make sure you clear out the contents of the drupal folder on your host machine, or Drupal will return some errors when the VM is rebuilt (it won't reinstall Drupal cleanly).
You can change the installed version of Drupal or drush, or any other configuration options, by editing the variables within config.yml.
Find out more about local development with Vagrant + VirtualBox + Ansible in this presentation: Local Development Environments - Vagrant, VirtualBox and Ansible.
Learn about how Ansible can accelerate your ability to innovate and manage your infrastructure by reading Ansible for DevOps.

License

This project is licensed under the MIT open source license.

About the Author

Jeff Geerling, owner of Midwestern Mac, LLC, created this project in 2014 so he could accelerate his Drupal core and contrib development workflow. This project, and others like it, are also featured as examples in Jeff's book, Ansible for DevOps.

FreekVR / drupal-vm