The Devilbox
![Devilbox](https://github.com/cytopia/devilbox/raw/master/docs/img/banner.png)
Quickstart |
Examples |
Features |
The Devilbox Stack |
Community |
Contributing |
Logos |
License
![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)
The Devilbox is a versatile and highly customisable zero-conf PHP Docker stack supporting LEMP and MEAN as well as Websockets, Node, Python and Golang via automated Reverse Proxy integraton.
The main goal is to provide a reproducible development environment that runs on all major platforms and is able to switch and combine any version you need.
It supports an unlimited number of projects for which vhosts, SSL certificates and DNS records are created automatically.
Email interception and popular development tools will be at your service as well. Configuration is not necessary, as everything is already pre-setup.
All created projects (frontend or backend) will be able to communicate with one another to support the emulation of a complete microservice architecture or an API landscape.
Available Architectures: amd64
, arm64
Available PHP Versions: 5.2
, 5.3
, 5.4
, 5.5
, 5.6
, 7.0
, 7.1
, 7.2
, 7.3
, 7.4
, 8.0
, 8.1
, 8.2
๐ Quickstart
โ System Requirements
The Devilbox runs on all major operating systems and its only requirement is Docker
and Docker Compose
:
![Linux](https://raw.githubusercontent.com/cytopia/icons/master/64x64/linux.png)
![OSX](https://raw.githubusercontent.com/cytopia/icons/master/64x64/osx.png)
![Windows](https://raw.githubusercontent.com/cytopia/icons/master/64x64/windows.png)
![Plus](https://raw.githubusercontent.com/cytopia/icons/master/64x64/plus.png)
![Docker](https://raw.githubusercontent.com/cytopia/icons/master/64x64/docker.png)
* [Docker Engine 17.06.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23)
* [Docker Compose 1.16.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23)
Be up and running in 2 minutes.
๐ Install and Run: Linux
Linux: Install
1. Download the Devilbox
```bash
git clone https://github.com/cytopia/devilbox
```
2. Enter the Devilbox git directory
```bash
cd devilbox
```
3. Copy the default environment file
```bash
cp env-example .env
```
Linux: Run
> :warning: 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
```bash
# 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
๐ Install and Run: MacOS
MacOS: Install
1. Download the Devilbox
```bash
git clone https://github.com/cytopia/devilbox
```
2. Enter the Devilbox git directory
```bash
cd devilbox
```
3. Copy the default environment file
```bash
cp env-example .env
```
MacOS: Run
> :warning: 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
```bash
# 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
๐ Install and Run: Windows
Note: If you are using WSL2
, refer to the Linux guide instead.
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
> :warning: 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
```bash
# 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
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
```bash
# Inside the Devilbox git directory
./shell.sh
```
2. On Windows without WSL2
```bash
# Inside the Devilbox git directory
./shell.bat
```
๐ก Examples
Create your first project:
Example: Dummy Project
1. Start the container you need:
```bash
docker-compose up httpd php mysql
```
2. Enter the work container:
```bash
./shell.sh
```
3. Navigate to `/shared/httpd`:
```bash
cd /shared/httpd
```
4. Create your project directory
```bash
mkdir dummy-project
```
5. Visit http://localhost/vhosts.php
You will notice that you need to create a `htdocs/` directory
6. Create `htdocs/` directory
```bash
# 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
```bash
# Navigate to your project htdocs directory
cd /shared/httpd/dummy-project/htdocs
# Create a simple index.php file
echo ' index.php
```
9. View your project in the browser: http://dummy-project.dvl.to
Example: PHP Framework
Find all the examples in the documentation:
:star: Features
The Devilbox tries to be a zero-configuration stack out of the box and has automated all the boring tasks. Additionally it provides common feature required for everyday work.
Automation
:star: Automated Project creation
:star: Automated SSL
:star: Automated DNS
:star: Host permission sync
|
Modes
:star: Static files
:star: PHP files
:star: Reverse Proxy
:star: Websockets
|
Backends
:star: PHP-FPM
:star: NodeJS
:star: Python
:star: Golang
:star: ...
|
Profiling
:star: Blackfire
:star: Xdebug
:star: XHProf
|
Projects
:star: Unlimited Projects
:star: Inter-Project Communication
:star: Custom Project domains
:star: Valid browser HTTPS
|
Intranet
:star: Virtual Hosts
:star: C&C
:star: Email Reader
:star: OpCache Gui
|
Batteries
:star: Adminer
:star: phpMyAdmin
:star: phpPgAdmin
:star: phpRedMind
|
Services
:star: SQL
:star: NoSQL
:star: Cache
:star: ...
|
The Devilbox Stack
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 its components and usage.
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
|
|
|
๐ป Modes of operation
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.
```bash
# 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:
![Devilbox](docs/img/devilbox-dash-selective.png)
#### On Demand
If the Devilbox is already started you can attach more container on-the-fly,
```bash
# 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
```bash
# 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
```bash
# Inside the Devilbox git directory start them all
docker-compose up
```
The Intranet will show you what container you have currently running:
![Devilbox](docs/_includes/figures/devilbox/devilbox-intranet-dash-all.png)
If you prefer a visual guide, have a look at the two introduction videos on Youtube:
> **Documentation:**
> [Install the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/install-the-devilbox.html) |
> [Start the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/start-the-devilbox.html) |
> [.env file](https://devilbox.readthedocs.io/en/latest/configuration-files/env-file.html)
๐ Available Container
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 | Web | App | SQL | NoSQL | Queue / Search | ELK | Utils |
|---------|------------|----------------|------------|-----------|----------------|---------------|-----------|
| HAProxy | Apache | PHP | MariaDB | Memcached | RabbitMQ | ElasticSearch | Bind |
| Varnish | Nginx | Python (Flask) | MySQL | MongoDB | Solr | Logstash | Blackfire |
| | | | PerconaDB | Redis | | Kibana | MailHog |
| | | | PostgreSQL | | | | Ngrok |
> **Documentation:**
> [Available Container](https://devilbox.readthedocs.io/en/latest/readings/available-container.html)
๐ Version Matrix
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
[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.
> **Documentation:**
> [Change container versions](https://devilbox.readthedocs.io/en/latest/getting-started/change-container-versions.html)
#### 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](https://devilbox.readthedocs.io/en/latest/custom-container/enable-all-container.html)
โ๏ธ Available PHP Extensions
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**
| 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 | PHP 8.1 | PHP 8.2 |
|-------------------------------|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|
| amqp | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| apc | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | | | | | | |
| apcu | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| bcmath | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| blackfire | | | | | d | d | d | d | d | d | d | | |
| bz2 | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| calendar | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| 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 | | | |
| json | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| ldap | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| libxml | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| lz4 | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| lzf | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| mbstring | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| mcrypt | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | |
| memcache | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| memcached | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| mhash | โ | โ | โ | โ | โ | | | | | | | | |
| mongo | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | | | | | | |
| mongodb | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| msgpack | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| mysql | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | | | | | | |
| mysqli | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| mysqlnd | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| OAuth | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| oci8 | | d | d | d | d | d | d | d | d | d | d | d | d |
| OPcache | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| openssl | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| pcntl | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| pcre | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| PDO | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| pdo_dblib | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| PDO_Firebird | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| pdo_mysql | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| PDO_OCI | | | | | | d | d | d | d | d | d | d | d |
| pdo_pgsql | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| pdo_sqlite | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| pdo_sqlsrv | | | | | | d | d | d | d | d | d | d | d |
| pgsql | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| phalcon | | d | d | d | d | d | d | d | d | d | d | d | |
| Phar | ๐ธ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| posix | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| pspell | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| psr | | | d | d | d | d | d | d | d | d | d | d | d |
| random | | | | | | | | | | | | | โ |
| rdkafka | | d | d | d | d | d | d | d | d | d | d | d | d |
| readline | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| recode | โ | โ | โ | โ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | | |
| redis | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| Reflection | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| session | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| shmop | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| SimpleXML | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| snmp | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| soap | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| sockets | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| sodium | | | | | | | | โ | โ | โ | โ | โ | โ |
| solr | | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | |
| SPL | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| sqlite | โ | โ | | | | | | | | | | | |
| sqlite3 | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| sqlsrv | | | | | | d | d | d | d | d | d | d | d |
| ssh2 | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | |
| swoole | | d | d | d | d | d | d | d | d | d | d | d | |
| sysvmsg | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| sysvsem | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| sysvshm | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| tidy | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| tokenizer | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| uploadprogress | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| uuid | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| vips | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | |
| wddx | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | | |
| Xdebug | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| xhprof | | | | | | d | d | d | d | d | d | d | d |
| xlswriter | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| xml | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| xmlreader | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| xmlrpc | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | | | |
| xmlwriter | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| xsl | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| yaml | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| zip | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
| zlib | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| zstd | | | | | | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ | ๐ธ |
> * 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](https://devilbox.readthedocs.io/en/latest/intermediate/enable-disable-php-modules.html)
๐ ๏ธ Available CLI Tools
Available Tools
Well-known and popular tools will be at your service:
| Tool | 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 | PHP 8.1 | PHP 8.2 |
|--------------------------------------------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|
| [angular-cli][lnk_angular-cli] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [asgardcms][lnk_asgardcms] | | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [awesome-ci][lnk_awesome-ci] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [codeception][lnk_codeception] | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**composer**][lnk_**composer**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**corepack**][lnk_**corepack**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [deployer][lnk_deployer] | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [eslint][lnk_eslint] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [git][lnk_git] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [git-flow][lnk_git-flow] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [grunt-cli][lnk_grunt-cli] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [gulp][lnk_gulp] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [jq][lnk_jq] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [jsonlint][lnk_jsonlint] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [laravel-installer][lnk_laravel-installer] | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [laravel-lumen][lnk_laravel-lumen] | | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [linkcheck][lnk_linkcheck] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [mdl][lnk_mdl] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [mdlint][lnk_mdlint] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [mupdf-tools][lnk_mupdf-tools] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [net-tools][lnk_net-tools] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**node**][lnk_**node**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**npm**][lnk_**npm**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**nvm**][lnk_**nvm**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [phalcon-devtools][lnk_phalcon-devtools] | | | | โ | โ | โ | โ | โ | โ | โ | โ | โ | |
| [php-cs-fixer][lnk_php-cs-fixer] | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | |
| [phpcbf][lnk_phpcbf] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [phpcs][lnk_phpcs] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [phpmd][lnk_phpmd] | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [phpunit][lnk_phpunit] | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**pip**][lnk_**pip**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [pm2][lnk_pm2] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [pwncat][lnk_pwncat] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [rsync][lnk_rsync] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [sass][lnk_sass] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [shellcheck][lnk_shellcheck] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [ssh][lnk_ssh] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [stylelint][lnk_stylelint] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [svn][lnk_svn] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [symfony-cli][lnk_symfony-cli] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [taskfile][lnk_taskfile] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [tig][lnk_tig] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [vim][lnk_vim] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [vue-cli][lnk_vue-cli] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [webpack-cli][lnk_webpack-cli] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [wkhtmltopdf][lnk_wkhtmltopdf] | | | | | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [wp-cli][lnk_wp-cli] | | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [wscat][lnk_wscat] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [yamllint][lnk_yamllint] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [**yarn**][lnk_**yarn**] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [yq][lnk_yq] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
| [zsh][lnk_zsh] | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ | โ |
[lnk_angular-cli]: ../php_tools/angular-cli
[lnk_asgardcms]: ../php_tools/asgardcms
[lnk_awesome-ci]: ../php_tools/awesome-ci
[lnk_codeception]: ../php_tools/codeception
[lnk_**composer**]: https://getcomposer.org/
[lnk_**corepack**]: https://nodejs.org/api/corepack.html
[lnk_deployer]: ../php_tools/deployer
[lnk_eslint]: ../php_tools/eslint
[lnk_git]: ../php_tools/git
[lnk_git-flow]: ../php_tools/git-flow
[lnk_grunt-cli]: ../php_tools/grunt-cli
[lnk_gulp]: ../php_tools/gulp
[lnk_jq]: ../php_tools/jq
[lnk_jsonlint]: ../php_tools/jsonlint
[lnk_laravel-installer]: ../php_tools/laravel-installer
[lnk_laravel-lumen]: ../php_tools/laravel-lumen
[lnk_linkcheck]: ../php_tools/linkcheck
[lnk_mdl]: ../php_tools/mdl
[lnk_mdlint]: ../php_tools/mdlint
[lnk_mupdf-tools]: ../php_tools/mupdf-tools
[lnk_net-tools]: ../php_tools/net-tools
[lnk_**node**]: https://nodejs.org/en/
[lnk_**npm**]: https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/
[lnk_**nvm**]: https://github.com/nvm-sh/nvm
[lnk_phalcon-devtools]: ../php_tools/phalcon-devtools
[lnk_php-cs-fixer]: ../php_tools/php-cs-fixer
[lnk_phpcbf]: ../php_tools/phpcbf
[lnk_phpcs]: ../php_tools/phpcs
[lnk_phpmd]: ../php_tools/phpmd
[lnk_phpunit]: ../php_tools/phpunit
[lnk_**pip**]: https://pypi.org/
[lnk_pm2]: ../php_tools/pm2
[lnk_pwncat]: ../php_tools/pwncat
[lnk_rsync]: ../php_tools/rsync
[lnk_sass]: ../php_tools/sass
[lnk_shellcheck]: ../php_tools/shellcheck
[lnk_ssh]: ../php_tools/ssh
[lnk_stylelint]: ../php_tools/stylelint
[lnk_svn]: ../php_tools/svn
[lnk_symfony-cli]: ../php_tools/symfony-cli
[lnk_taskfile]: ../php_tools/taskfile
[lnk_tig]: ../php_tools/tig
[lnk_vim]: ../php_tools/vim
[lnk_vue-cli]: ../php_tools/vue-cli
[lnk_webpack-cli]: ../php_tools/webpack-cli
[lnk_wkhtmltopdf]: ../php_tools/wkhtmltopdf
[lnk_wp-cli]: ../php_tools/wp-cli
[lnk_wscat]: ../php_tools/wscat
[lnk_yamllint]: ../php_tools/yamllint
[lnk_**yarn**]: https://yarnpkg.com/cli/install
[lnk_yq]: ../php_tools/yq
[lnk_zsh]: ../php_tools/zsh
๐ Supported Frameworks
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](https://devilbox.readthedocs.io/en/latest/examples/setup-cakephp.html) |
> [Setup CodeIgniter](https://devilbox.readthedocs.io/en/latest/examples/setup-codeigniter.html) |
> [Setup Contao](https://devilbox.readthedocs.io/en/latest/examples/setup-contao.html) |
> [Setup CraftCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-craftcms.html) |
> [Setup Drupal](https://devilbox.readthedocs.io/en/latest/examples/setup-drupal.html) |
> [Setup Joomla](https://devilbox.readthedocs.io/en/latest/examples/setup-joomla.html) |
> [Setup Laravel](https://devilbox.readthedocs.io/en/latest/examples/setup-laravel.html) |
> [Setup Magento 2](https://devilbox.readthedocs.io/en/latest/examples/setup-magento2.html) |
> [Setup PhalconPHP](https://devilbox.readthedocs.io/en/latest/examples/setup-phalcon.html) |
> [Setup PhotonCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-photon-cms.html) |
> [Setup PrestaShop](https://devilbox.readthedocs.io/en/latest/examples/setup-presta-shop.html) |
> [Setup ProcessWire](https://devilbox.readthedocs.io/en/latest/examples/setup-processwire.html) |
> [Setup Shopware](https://devilbox.readthedocs.io/en/latest/examples/setup-shopware.html) |
> [Setup Symfony](https://devilbox.readthedocs.io/en/latest/examples/setup-symfony.html) |
> [Setup Typo3](https://devilbox.readthedocs.io/en/latest/examples/setup-typo3.html) |
> [Setup WordPress](https://devilbox.readthedocs.io/en/latest/examples/setup-wordpress.html) |
> [Setup Yii](https://devilbox.readthedocs.io/en/latest/examples/setup-yii.html) |
> [Setup Zend](https://devilbox.readthedocs.io/en/latest/examples/setup-zend.html)
#### 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](https://devilbox.readthedocs.io/en/latest/examples/setup-reverse-proxy-nodejs.html) |
> [Setup reverse proxy Sphinx documentation](https://devilbox.readthedocs.io/en/latest/examples/setup-reverse-proxy-sphinx-docs.html)
๐ Devilbox Intranet
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:
> **Documentation:**
> [Devilbox Intranet](https://devilbox.readthedocs.io/en/latest/getting-started/devilbox-intranet.html)
๐ธ Screenshots
Screenshots
A few examples of how the built-in intranet looks like.
๐ซ 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
Discord chat or visit the forums and get community support quickly.
๐ค Contributing
The Devilbox is still a young project with a long roadmap ahead. Features are decided by you - the community, so any kind of contribution is welcome.
- Star this project
- Open up issues for bugs and feature requests
- Clone this project and submit fixes or features
๐ง Maintainer
I try to keep up with literally over 100 projects.
If my work is making your life easier, consider sending coffee or beer. ๐ค
Contributions: PyPI: cytopia ยท
Terraform: cytopia ยท
Ansible: cytopia
๐ Logos
Logos and banners can be found at devilbox/artwork. Feel free to use or modify them by the terms of their license.
![](https://github.com/devilbox/artwork/blob/master/submissions_banner/cytopia/01/png/banner_128_trans.png?raw=true)
๐ License
MIT License
Copyright (c) 2016 cytopia