The Devilbox

Usage | Architecture | Community | Features | Intranet | Screenshots | Contributing | Logos | License

_{Support for valid https out of the box.}

The Devilbox is a modern and highly customisable dockerized PHP stack supporting full LAMP and MEAN and running on all major platforms. The main goal is to easily switch and combine any version required for local development. It supports an unlimited number of projects for which vhosts, SSL certificates and DNS records are created automatically. Reverse proxies per project are supported to ensure listening server such as NodeJS can also be reached. Email catch-all and popular development tools will be at your service as well. Configuration is not necessary, as everything is already pre-setup.

Furthermore, the Devilbox provides an identical and reproducible development environment for different host operating systems.

Requirements

• Docker Engine 1.12.0+
• Docker Compose 1.9.0+

Architecture

Available Stacks

The Devilbox aims to be a swiss army knife for local development by providing you all the services you would ever need. To get an idea about the architecture behind it and to also see what's available have a look at the following diagrams and tables.

Smallest stack This is the smallest possible and fully functional stack you can run	Full stack To better understand what is actually possible have a look at the full example

Devilbox artwork

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.

Accel	Frontend	SQL	NoSQL	Queue	Search	ELK	Utils
HAProxy	Apache	MariaDB	Memcached	RabbitMQ	Solr	ElasticSearch	Bind
Varnish	Nginx	MySQL	MongoDB			Logstash	Blackfire
	PHP	PerconaDB	Redis			Kibana	MailHog
		PostgreSQL					Ngrok

Documentation: Available Container

Community

The Devilbox has a lot of features reaching from a simple single-user development environment that works out of the box up to a shared development infrastructure for a corporate network.

In order to be aware about all that features, ensure to have skimmed over the documentation, so you know what can be done and how that might simplify your every-day life. If you ever run into any unforseen issues, feel free to join the chat or visit the forums and get community support quickly.

Documentation	Chat	Forum	Flames
devilbox.readthedocs.io	gitter.im/devilbox	devilbox.discourse.group	github.com/devilbox/flames

Usage

Quick start

Linux and MacOS	Windows
# Get the Devilbox git clone https://github.com/cytopia/devilbox # Create docker-compose environment file cd devilbox cp env-example .env # Edit your configuration vim .env # Start all container docker-compose up	1. Clone https://github.com/cytopia/devilbox to C:\devilbox with Git for Windows 2. Copy C:\devilbox\env-example to C:\devilbox\.env 3. Edit C:\devilbox\.env 4. Open a terminal on Windows and type: # Start all container C:\devilbox> docker-compose up

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

Selective start

The above will start all containers, you can however also just start the containers you actually need. This is achieved by simply specifying them in the docker-compose command.

docker-compose up httpd php mysql redis

Documentation: Start only some container

Run different versions

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.

Apache	Nginx	PHP	MySQL	MariaDB	Percona	PgSQL	Redis	Memcached	MongoDB
2.2	stable	5.2[1]	5.5	5.5	5.5	9.0	2.8	1.4	2.8
2.4	mainline	5.3	5.6	10.0	5.6	9.1	3.0	1.5	3.0
		5.4	5.7	10.1	5.7	9.2	3.2	latest	3.2
		5.5	8.0	10.2	8.0	9.3	4.0		3.4
		5.6		10.3		9.4	5.0		3.6
		7.0		10.4		9.5	latest		4.0
		7.1				9.6			latest
		7.2				...
		7.3				11.1
		7.4[2]				latest
		8.0[2]

^[1] PHP 5.2 is available to use, but it is not officially supported. The Devilbox intranet does not work with this version as PHP 5.2 does not support namespaces. Furthermore PHP 5.2 does only work with Apache 2.4, Nginx stable and Nginx mainline. It does not work with Apache 2.2. Use at your own risk.

^[2] PHP 7.4 and PHP 8.0 are upcoming unreleased versions of PHP, which are directly built out of their official git branches every night to assure you will leverage their latest features.

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.

Blackfire	ELK	MailHog	Ngrok	RabbitMQ	Solr	HAProxy	Varnish
1.8	5.x.y	v1.0.0	2.x	3.6	5	1.x	4
...	6.x.y	latest		3.7	6		5
1.18.0	7.x.y			latest	7		6
latest					latest		latest

Documentation: Enable custom container

Enter the container

You can also work directly inside the php container. Simply use the bundled scripts shell.sh (or shell.bat for Windows). The PS1 will automatically be populated with current chosen php version. Navigate the the Devilbox directory and type the below listed command:

Linux and MacOS	Windows
host> ./shell.sh [email protected] in /shared/httpd $	C:\devilbox> shell.bat [email protected] in /shared/httpd $

Your projects can be found in /shared/httpd. DNS records are automatically available inside the php container. Also every other service will be available on 127.0.0.1 inside the php container (tricky socat port-forwarding).

Documentation: Work inside the PHP container | Directory overview

Quick Video intro

Feature overview

The Devilbox has everything setup for you. The only thing you will have to install is Docker and Docker Compose. Virtual hosts and DNS entries will be created automatically, just by adding new project folders.

Documentation: Devilbox Prerequisites

Features

⭐ HTTPS support	HTTPS is available by default for all projects and the bundled Intranet.
⭐ HTTP/2 support	All HTTPS connections will offer HTTP/2 as the default protocol, except for Apache 2.2 which does not support it.
⭐ Auto virtual hosts	New virtual hosts are created automatically and instantly whenever you add a project directory. This is done internally via vhost-gen and watcherd.
⭐ Automated SSL certs	Valid SSL certificates for HTTPS are automatically created for each vhost and signed by the Devilbox CA.
⭐ Unlimited vhosts	Run as many projects as you need with a single instance of the Devilbox.
⭐ Custom vhosts	You can overwrite and customise the default applied vhost configuration for every single vhost.
⭐ Reverse proxy	Have your NodeJS application served with a nice domain name and valid HTTPS.
⭐ Custom domains	Choose whatever development domain you desire: *.loc, *.dev or use real domains as well: *.example.com
⭐ Auto DNS	An integrated BIND server is able to create DNS entries automatically for your chosen domains.
⭐ Auto start scripts	Custom startup scripts can be provided for all PHP container equally and also differently per PHP version to install custom software or automatically startup up your required tools.
⭐ Custom PHP config	Overwrite any setting for PHP.
⭐ Custom PHP modules	Load custom PHP modules on the fly.
⭐ Email catch-all	All outgoing emails are catched and will be presented in the included intranet.
⭐ Self-validation	Projects and configuration options are validated and marked in the intranet.
⭐ Xdebug	Xdebug and a full blown PHP-FPM server is ready to serve.
⭐ Devilbox Flames	Devilbox community plugins a.k.a. Devilbox Flames.
⭐ Many more	See Documentation for all available features.

Documentation: Setup Auto DNS | Setup valid HTTPS | Configure Xdebug | Customize PHP

Batteries

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

Adminer	phpMyAdmin	phpPgAdmin	phpRedMin	PHPMemcached Admin	OpCache GUI	Mail viewer

Documentation: Devilbox Intranet

Tools

The following tools will assist you on creating new projects easily as well as helping you check your code against guidelines.

🔧 awesome-ci	A set of tools for static code analysis: file-cr, file-crlf, file-empty, file-nullbyte-char, file-trailing-newline, file-trailing-single-newline, file-trailing-space, file-utf8, file-utf8-bom, git-conflicts, git-ignored, inline-css, inline-js, regex-grep, regex-perl, syntax-bash, syntax-css, syntax-js, syntax-json, syntax-markdown, syntax-perl, syntax-php, syntax-python, syntax-ruby, syntax-scss, syntax-sh
🔧 git flow	git-flow is a Git extensions to provide high-level repository operations for Vincent Driessen's branching model.
🔧 json lint	jsonlint is a command line linter for JSON files.
🔧 laravel installer	laravel is a command line tool that lets you easily install the Laravel framework.
🔧 linkcheck	linkcheck is a command line tool that searches for URLs in files (optionally limited by extension) and validates their HTTP status code.
🔧 linuxbrew	brew is a MacOS Homenbrew clone for Linux.
🔧 markdownlint	markdownlint is a markdown linter.
🔧 mdl	mdl is a markdown linter.
🔧 phalcon devtools	phalcon is a command line tool that lets you easily install the PhalconPHP framework.
🔧 photon installer	photon is a command line tool that lets you easily install the PhotonCMS.
🔧 php code sniffer	phpcs is a command line tool that tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
🔧 php code beautifier	phpcbf is a command line tool that automatically correct coding standard violations.
🔧 php cs fixer	php-cs-fixer is a tool to automatically fix PHP Coding Standards issues.
🔧 pm2	pm2 is Node.js Production Process Manager with a built-in Load Balancer.
🔧 scss-lint	scss-lint is a css/scss linter.
🔧 symfony installer	symfony is a command line tool that lets you easily install the Symfony framework.
🔧 tig	tig is a text-mode interface for git.
🔧 wp-cli	wp is a command line tool that lets you easily install WordPress.
🔧 yamllint	yamllint is a linter for yaml files.

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

Documentation: Available Tools

Available PHP Modules

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

Modules	PHP 5.2	PHP 5.3	PHP 5.4	PHP 5.5	PHP 5.6	PHP 7.0	PHP 7.1	PHP 7.2	PHP 7.3	PHP 7.4	PHP 8.0
amqp	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
apc		🗸	🗸	🗸	🗸
apcu		🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
bcmath	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
blackfire					d	d	d	d	d
bz2	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
calendar	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
Core		✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
ctype	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
curl	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
date	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
dba	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
dom	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
enchant	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
ereg		✔	✔	✔	✔
exif	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
FFI										🗸	✔
fileinfo	🗸	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
filter	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
ftp	🗸	🗸	🗸	✔	✔	✔	✔	✔	✔	✔	✔
gd	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
gettext	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
gmp		🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
hash	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
iconv	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
igbinary	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
imagick		🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
imap	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
interbase	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
intl	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
ioncube	d	d	d	d	d	d	d	d
json	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
ldap	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
libxml	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
mbstring	✔	🗸	🗸	✔	✔	✔	✔	✔	✔	✔	✔
mcrypt	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
memcache	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
memcached	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
mhash					✔
mongo	🗸	🗸	🗸	🗸	🗸
mongodb		🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
msgpack	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
mysql	✔	✔	🗸	🗸	🗸
mysqli	✔	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
mysqlnd		✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
OAuth	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
oci8		d	d	d	d	d	d	d	d	d	d
openssl	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
pcntl	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
pcre	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
PDO	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
pdo_dblib	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
PDO_Firebird	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
pdo_mysql	✔	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
PDO_OCI						d	d	d	d	d	d
pdo_pgsql	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
pdo_sqlite	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
pdo_sqlsrv						d	d	d	d
pgsql	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
phalcon		🗸	🗸	🗸	🗸	🗸	🗸	🗸
Phar	🗸	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
posix	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
pspell	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
rdkafka		d	d	d	d	d	d	d	d	d
readline	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
recode	🗸	✔	✔	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
redis	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
Reflection	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
session	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
shmop	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
SimpleXML	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
snmp	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
soap	✔	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
sockets	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
sodium								✔	✔	✔	✔
SPL	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
SQLite	✔	✔
sqlite3		✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
sqlsrv						d	d	d	d
standard	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
swoole		d	d	d	d	d	d	d	d	d
sysvmsg	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
sysvsem	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
sysvshm	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
tidy	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
tokenizer	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
uploadprogress	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
wddx	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
xdebug	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
xml	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
xmlreader	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
xmlrpc	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
xmlwriter	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
xsl	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
Zend OPcache	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
zip	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸	🗸
zlib	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔

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

PHP modules can be enabled or disabled on demand to reflect the state of your target environment.

Documentation: Enable/disable PHP modules

Custom PHP Modules

You can also copy any custom modules into mod/(php-fpm)-<VERSION> and add a custom *.ini file to load them.

Supported 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 | Setup PhalconPHP | Setup PhotonCMS | Setup PrestaShop | Setup ProcessWire | Setup Shopware | Setup Symfony | Setup Typo3 | Setup WordPress | Setup Yii | Setup Zend

Supported reverse proxied 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

Intranet overview

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)
• Database overview (MySQL, PgSQL, Redis, Memcache, ...)
• Email overview
• Info pages (Httpd, MySQL, PgSQL, Redis, Memcache, ...)
• Adminer
• phpMyAdmin
• phpPgAdmin
• phpRedMin
• PHPMemcachedAdmin
• OpcacheGUI

Documentation: Devilbox Intranet

Screenshots

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

Contributing

The Devilbox is still a young project with a long roadmap of features to come. Features are decided by you - the community, so any kind of contribution is welcome.

To increase visibility and bug-free operation:

• Star this project
• Open up issues for bugs and feature requests
• Clone this project and submit fixes or features
• Visit the Devilbox Community Forums for announcements and to help others

Additionally you can subscribe to Devilbox on CodeTriage, read up on CONTRIBUTING.md and check the ROADMAP about what is already planned for the near future.

Logos

Logos and banners can be found at devilbox/artwork. Feel free to use or modify them by the terms of their license.

License

MIT License

Copyright (c) 2016 cytopia