Skip to content


In the Vagrant approach, you install buildkit in a local virtual-machine. It looks and feels like a remote server.

The Vagrant integration has not been updated in several years.

Major features

These instructions will create a virtual-machine with the following features:

  • Interpreters: PHP-CLI, NodeJS
  • Servers: Apache HTTPD, MySQL, PHP-FPM, Mailcatcher, Memcached
  • Web Applications: phpMyAdmin

Additionally, it includes a copy of buildkit.

  • Pro: The Vagrant approach works equally well on Windows, MacOS, and Linux. Configuration is packaged, editable, and disposable.
  • Con: Using Vagrant feels like using a remote server, so it may be difficult to integrate debuggers and other desktop tools. File-sync can be a performance drag. At time of writing, may not work well with arm64 CPUs.


  • Vagrant and a compatible hypervisor
  • Intel/AMD CPU (The Vangrant core may be compatible with other CPUs, but there are currently compatibility issues with hypervisors and specific Vagrantboxes.)


The civicrm-buildkit-vagrant project provides a virtual machine with all system requirements. For more instructions, see the README:

Next steps

Once you are able to login to the Vagrantbox, you can move on to using civibuild.