Setup Magento 2¶
This example will use
composer to install Magento 2 from within the Devilbox PHP container.
composer requires the underlying file system to support symlinks. If you
use Docker Toolbox you need to explicitly allow/enable this.
See below for instructions:
- Docker Toolbox and Symlinks
After completing the below listed steps, you will have a working Magento 2 setup ready to be served via http and https.
Table of Contents
The following configuration will be used:
|Project name||VirtualHost directory||Database||TLD_SUFFIX||Project URL|
- Inside the Devilbox PHP container, projects are always in
- On your host operating system, projects are by default in
./data/www/inside the Devilbox git directory. This path can be changed via HOST_PATH_HTTPD_DATADIR.
This example requires to use Apache 2.4, as Magento does a lot of
.htaccess magic by default
and these files are not interpreted by Nginx.
If you still want to use Nginx instead, you will have to overwrite your vhost configuration to
.htaccess rules are glued into your Nginx vhost configuration.
It will be ready in eight simple steps:
- Enter the PHP container
- Create a new VirtualHost directory
- Install Magento 2 via
- Symlink webroot directory
- Add MySQL database
- Setup DNS record
- Visit http://my-magento.loc in your browser
1. Enter the PHP container¶
All work will be done inside the PHP container as it provides you with all required command line tools.
Navigate to the Devilbox git directory and execute
shell.bat on Windows) to
enter the running PHP container.
2. Create new vhost directory¶
The vhost directory defines the name under which your project will be available.
<vhost dir>.TLD_SUFFIX will be the final URL ).
email@example.com in /shared/httpd $ mkdir my-magento
3. Install Magento 2¶
Navigate into your newly created vhost directory and install Magento 2 with
firstname.lastname@example.org in /shared/httpd $ cd my-magento # Download Magento 2 via git email@example.com in /shared/httpd/my-magento $ git clone https://github.com/magento/magento2 # Checkout the latest stable git tag firstname.lastname@example.org in /shared/httpd/my-magento $ cd magento2 email@example.com in /shared/httpd/my-magento/magento2 $ git checkout 2.2.5 # Install dependencies with Composer firstname.lastname@example.org in /shared/httpd/my-magento/magento2 $ composer install
How does the directory structure look after installation:
email@example.com in /shared/httpd/my-magento $ tree -L 1 . └── magento2 1 directory, 0 files
4. Symlink webroot¶
Symlinking the actual webroot directory to
htdocs is important. The web server expects every
project’s document root to be in
<vhost dir>/htdocs/. This is the path where it will serve
the files. This is also the path where your frameworks entrypoint (usually
Some frameworks however provide its actual content in nested directories of unknown levels. This would be impossible to figure out by the web server, so you manually have to symlink it back to its expected path.
firstname.lastname@example.org in /shared/httpd/my-magento $ ln -s magento2/ htdocs
How does the directory structure look after symlinking:
email@example.com in /shared/httpd/my-magento $ tree -L 1 . ├── magento2 └── htdocs -> magento2 2 directories, 0 files
As you can see from the above directory structure,
htdocs is available in its expected
path and points to the frameworks entrypoint.
When using Docker Toolbox, you need to explicitly allow the usage of symlinks. See below for instructions:
- Docker Toolbox and Symlinks
5. Add MySQL Database¶
firstname.lastname@example.org in /shared/httpd/my-magento $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_magento;'
7. DNS record¶
If you have Auto DNS configured already, you can skip this section, because DNS entries will be available automatically by the bundled DNS server.
If you don’t have Auto DNS configured, you will need to add the following line to your
host operating systems
/etc/hosts file (or
C:\Windows\System32\drivers\etc on Windows):
8. Open your browser¶
All set now, you can visit http://my-magento.loc or https://my-magento.loc in your browser and follow the installation steps.
127.0.0.1 for the MySQL database hostname.
Once everything is installed and setup correctly, you might be interested in a few follow-up topics.
Use bundled batteries¶
The Devilbox ships most common Web UIs accessible from the intranet.
Enhance the Devilbox¶
Go ahead and make the Devilbox more smoothly by setting up its core features.
In case your framework/CMS requires it, attach caching, queues, database or performance tools.
Stay inside the container and use what’s available.