Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.

Magento 2 SE box

Get this repo

$ git clone --recursive

When you forgot the --recursive part you can update the submodules recursive.

$ git submodule update --init --recursive


The box needs a config.yml file. For everyones convenience there is a config.yml.example provided.

project: 'magento2'
type: 'magento2-ce'
ip: ''
path: '../magento2'
memory: 1024
cpus: 1

So as you can see from the sample you can customize the project name (this will have impact on the hostname shown to you when you ssh into the box). The host-only ip address can be configured, so when you have more than one of these boxes running you can do so without conflicting. The path to the root of your project must be defined. And in case you must you can add more memory and more cpus to the configuration to avoid sluggish responses when developing.

The type given in the configuration will cause a specific provisioning script to be used. Now we provide magento2-ce and magento2-ee installations. As an extra there is now a magento2-ce-elastic. Thatone will give you everything for community edition + elasticsearch.


For frontend development there is a grunt config file available in magento so grunt is globally installed in this box. For use with magento you also need a project local part installed. You can find how to install grunt in the (magento2 devdocs)[].

What we need to do locally to get started with grunt is:

$ cd /var/www/website
$ npm install

And we need to prepare the 'frontend' files. Here we must make sure there is nothing left in the static folder, if there is something left there, there is a big chance your grunt flow will not work properly. For custom theming do not forget to update dev/tools/grunt/configs/themes.js.

$ rm -rf pub/static/*
$ bin/magento dev:source-theme:deploy
$ grunt watch

Use the appropriate options for dev:source-theme:deploy!


We are using nginx with php-fpm. The modules needed for magento are installed and are working. For convenience reasons there are aliases available for you to restart nginx: rn and to restart php-fpm: rp.

The default vhost has no server name so it will respond on every address you throw at it.

For php debugging xdebug is also installed and configured to automatically callback to the 'caller' machine on port 9000. When you want to debug cli scripts you must add the XDEBUG_CONFIG env var before running the php script.

$ XDEBUG_CONFIG="remote_host=" php myscript.php

PHPSTORM users might need to add more to have a smooth debugging experience.

$ XDEBUG_CONFIG="remote_host=" PHP_IDE_CONFIG="serverName=default" php myscript.php


By default mysql is installed and creates a database. You can connect to the database with the following credentials:

user: root
password: toor
database: magento2


By default memcached is installed and can be used in magento to store the sessions. When you want to use memcached add the following to app/etc/env.php:

  'session' => [
    'save' => 'memcached',
    'save_path' => '',

You can view the memcached stats and issue some commands to it via phpmemacheadmin. The phpmemcachedadmin listens for a wildcard domain phpmemcacheadmin.*.test. When we are using magento2 we can for example add phpmemcacheadmin.magento2.test to our hosts file. phpmemcacheadmin.magento2.test


There is a redis server available and it can be used in magento for page caching. To use redis as page caching mechanism add the following to app/etc/env.php:

  'cache' => [
    'frontend' => [
      'page_cache' => [
        'backend' => 'Cm_Cache_Backend_Redis',
        'backend_options' => [
          'server' => '',
          'port' => '6379',
          'persistent' => '',
          'database' => 1,
          'password' => '',
          'force_standalone' => 0,
          'connect_retries' => 1,

phpredmin is also available on a wildcard domain phpredmin.*.test. So we can for example add the following to our hosts file: phpredmin.magento2.test


By default mailcatcher is running and listening on port 25. It is also added as sendmail binary to your php setup.

To check the mails just browse to your defined ip port 8025. For example, or if you have magento2.test in your hosts file http://magento2.test:1080.

For convenience there is a wildcard domain mailcatcher.*.test. So we can also add thisone to our hosts file: mailcatcher.magento2.test


Varnish is setup with the default vcl for magento2. If you want to test how your magento2 site behaves with varnish you can browse to http://magento2.test:6081.

TODO: add an admin dashboard for varnish


There is Beanstalkd available when you want to do some simple queuing. This is rather for internal projects only since for Magento we probably will use rabbitmq by default.

For convenience there is a beanstalk admin installed which is reacheable on http://phpbeanstalkadmin.magento2.test

You could add an entry for that in your hosts file: phpbeanstalkadmin.magento2.test


Available for Enterprise Magento2 installations.

The management interface of rabbitmq is installed and reachable on http://rabbitmq.magento2.test rabbitmq.magento2.test


ElasticHQ is installed as UI to get insight into your local elasticsearch cluster. If put in your hosts file you can reach it on http://elastichq.magento2.test elastichq.magento2.test

Because Magento Commerce supports Elasticsearch 2 and 5 and Elastic Suite for the community edition is now optimized for Elasticsearch 5.x the default choice is Elasticsearch 5.x .


  • the website is always mapped to /var/www/website
  • www will cd you to the website path
  • rn will restart nginx
  • rp will restart php-fpm

Example Hosts File magento2.test phpbeanstalkadmin.magento2.test mailcatcher.magento2.test phpmemcacheadmin.magento2.test rabbitmq.magento2.test phpredmin.magento2.test elastichq.magento2.test

Flavours (type)

All boxes are currently based on Ubuntu Bionic (18.04)

  • magento2-ce-php7.0: configuration for Magento Community with php 7.0
  • magento2-ce-php7.1: configuration for Magento Community with php 7.1
  • magento2-ce-php7.2: configuration for Magento Community with php 7.2
  • magento2-ee-php7.0: configuration for Magento Commerce with php 7.0
  • magento2-ee-php7.1: configuration for Magento Commerce with php 7.1
  • magento2-ee-php7.2: configuration for Magento Commerce with php 7.1

Special flavors:

  • magento2-ce-php7.0-elastic: configuration for Magento Community with php 7.0 with elasticearch 5.x
  • magento2-ce-php7.1-elastic: configuration for Magento Community with php 7.1 with elasticearch 5.x
  • magento1-ce-php5.6: should work configuration for magento1 with php 5.6
  • magento1-ce-php7.0: should work configuration for magento1 with php 7.0
  • magento1-ce-php7.1: should work configuration for magento1 with php 7.1
  • magento1-ce-php7.2: should work configuration for magento1 with php 7.2


No description, website, or topics provided.




No releases published


No packages published