• Docker Engine 17.06.0+
• Docker Compose 1.16.0+

Linux: Install

1. Download the Devilbox

   git clone https://github.com/cytopia/devilbox

2. Enter the Devilbox git directory

   cd devilbox

3. Copy the default environment file

   cp env-example .env

Linux: Run

⚠️ Important: Ensure that nothing is listening on port 80 and 443 on your host system. These ports are required by the Devilbox webserver.

1. Start httpd, php and mysql container

   # This step may take a few minutes as required
   # Docker images have to be pulled initially.
   
   # Inside the Devilbox git directory
   docker-compose up httpd php mysql

2. Visit http://localhost in your browser

MacOS: Install

1. Download the Devilbox

   git clone https://github.com/cytopia/devilbox

2. Enter the Devilbox git directory

   cd devilbox

3. Copy the default environment file

   cp env-example .env

MacOS: Run

⚠️ Important: Ensure that nothing is listening on port 80 and 443 on your host system. These ports are required by the Devilbox webserver.

1. Start httpd, php and mysql container

   # This step may take a few minutes as required
   # Docker images have to be pulled initially.
   
   # Inside the Devilbox git directory
   docker-compose up httpd php mysql

2. Visit http://localhost in your browser

Windows: Install

1. Clone https://github.com/cytopia/devilbox to C:\devilbox with Git for Windows
2. Copy C:\devilbox\env-example to C:\devilbox.env

Windows: Run

⚠️ Important: Ensure that nothing is listening on port 80 and 443 on your host system. These ports are required by the Devilbox webserver.

Open a terminal on Windows and start httpd, php and mysql container:

1. Start httpd, php and mysql container

   # This step may take a few minutes as required
   # Docker images have to be pulled initially.
   
   # Inside the Devilbox git directory
   docker-compose up httpd php mysql

2. Visit http://localhost in your browser

Enter the work container

The Devilbox allows you to work on your projects on the host system as well as inside the work container. Your project files will be available at both locations. The workflow ususally is:

1. Use your prefered IDE (e.g. PhpStorm) on your host system to add and alter files
2. Work inside the container to run common cli tools such as node, composer, npm, phpcs, webpack and many more.

To enter the work container, simply run ./shell.sh

1. On Linux, MacOS and Windows with WSL2

   # Inside the Devilbox git directory
   ./shell.sh

2. On Windows without WSL2

   # Inside the Devilbox git directory
   ./shell.bat

1. Start the container you need:

   docker-compose up httpd php mysql

2. Enter the work container:

   ./shell.sh

3. Navigate to /shared/httpd:

   cd /shared/httpd

4. Create your project directory

   mkdir dummy-project

5. Visit http://localhost/vhosts.php
   You will notice that you need to create a htdocs/ directory
   
6. Create htdocs/ directory

   # Navigate to your project directory
   cd /shared/httpd/dummy-project
   
   # Create htdocs dir
   mkdir htdocs

7. Visit http://localhost/vhosts.php
   You will see that everything is now setup and your project is created and available
   
8. Create an index.php file

   # Navigate to your project htdocs directory
   cd /shared/httpd/dummy-project/htdocs
   
   # Create a simple index.php file
   echo '<?php echo "it works";' > index.php

9. View your project in the browser: http://dummy-project.dvl.to

Find all the examples in the documentation:

Modes of operation

You can startup and operate the Devilbox in three different ways via docker-compose:

1. Selective startup
2. On Demand (add/remove container while running)
3. Full startup

Selective startup

If you already know what kind of container you need before starting the Devilbox, you can just specify them explicitly.

# Inside the Devilbox git directory start httpd php mysql and redis
docker-compose up httpd php mysql redis

The Intranet will show you what container you have currently running:

On Demand

If the Devilbox is already started you can attach more container on-the-fly,

# Inside the Devilbox git directory attach mongo and memcached
docker-compose up mongo memcd

You can also shut down specific containers that you do not need

# Inside the Devilbox git directory shutdown redis
docker-compose stop redis

Full startup

If you just want to start everything, run docker-compose up without any arguments

# Inside the Devilbox git directory start them all
docker-compose up

The Intranet will show you what container you have currently running:

If you prefer a visual guide, have a look at the two introduction videos on Youtube:

Documentation: Install the Devilbox | Start the Devilbox | .env file

Available Container

The following table lists all integrated and pre-configured Docker container shipped by the Devilbox. Only the webserver and PHP container are mandatory, all others are optional and don't need to be started.

Each of them is also available in multiple different versions in order to reflect your exact desired environment.

Documentation: Available Container

Version Matrix

Every single attachable container comes with many different versions. In order to select the desired version for a container, simply edit the .env file and uncomment the version of choice. Any combination is possible.

Run different versions

Documentation: Change container versions

Additional services

Additionally to the default stack, there are a variety of other services that can be easily enabled and started.

Documentation: Enable custom container

Available PHP Extensions

The Devilbox is a development stack, so it is made sure that a lot of PHP modules are available out of the box in order to work with many different frameworks.

• Core enabled (cannot be disabled): ✔
• Enabled (can be disabled): 🗸
• Available, but disabled (can be enabled): d

• Core enabled (cannot be disabled): ✔
• Enabled (can be disabled): 🗸
• Available, but disabled (can be enabled): d

Documentation: Enable/disable PHP modules

Available Tools

Well-known and popular tools will be at your service:

Supported Frameworks

PHP Frameworks

As far as tested there are no limitations and you can use any Framework or CMS just as you would on your live environment. Below are a few examples of extensively tested Frameworks and CMS:

Documentation:
Setup CakePHP | Setup CodeIgniter | Setup Contao | Setup CraftCMS | Setup Drupal | Setup Joomla | Setup Laravel | Setup Magento 2 | Setup PhalconPHP | Setup PhotonCMS | Setup PrestaShop | Setup ProcessWire | Setup Shopware | Setup Symfony | Setup Typo3 | Setup WordPress | Setup Yii | Setup Zend

Reverse Proxy Applications

As far as tested there are no limitations and you can use any application that creates an open port. These ports will be reverse proxied by the web server and even allow you to use valid HTTPS for them. By the built-in autostart feature of the Devilbox you can ensure that your application automatically starts up as soon as you run docker-compose up.

Documentation:
Setup reverse proxy NodeJs | Setup reverse proxy Sphinx documentation

Devilbox Intranet

The Devilbox comes with a pre-configured intranet on http://localhost and https://localhost. This can be explicitly disabled or password-protected. The intranet will not only show you, the chosen configuration, but also validate the status of the current configuration, such as if DNS records exists (on host and container), are directories properly set-up. Additionally it provides external tools to let you interact with databases and emails.

• Virtual Host overview (validates directories and DNS)
• Command & Control
• Email overview
• Database overview (MySQL, PgSQL, Redis, Memcache, ...)
• Info pages (Httpd, MySQL, PgSQL, Redis, Memcache, ...)
• And many more...

The following batteries are available in the Devilbox intranet by default:

Adminer	phpMyAdmin	phpPgAdmin	phpRedMin	PHP Memcached Admin	OpCache GUI	Mail viewer

Documentation: Devilbox Intranet

Screenshots

A few examples of how the built-in intranet looks like.