diff --git a/README.md b/README.md index b4a42902..7d354f25 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ [![Release](https://img.shields.io/github/release/cytopia/devilbox.svg?colorB=orange)](https://github.com/cytopia/devilbox/releases) [![Discord](https://img.shields.io/discord/1051541389256704091?color=8c9eff&label=Discord&logo=discord)](https://discord.gg/2wP3V6kBj4) [![Discourse](https://img.shields.io/discourse/https/devilbox.discourse.group/status.svg?colorB=%234CB697&label=Discourse&logo=discourse)](https://devilbox.discourse.group) -[![type](https://img.shields.io/badge/type-Docker-blue.svg)](https://www.docker.com/) [![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT) + + -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. +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. -Furthermore, the Devilbox provides an **identical** and **reproducible development environment** for different host operating systems. +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 required for your projects. +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. -**Requirements** +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) +
-## Architecture +
+Be up and running in 2 minutes. +
🚀 Install and Run: Linux -#### Available Stacks +

Linux: Install

-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. +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 +
+
Example: PHP Framework +

+ +Find all the examples in the documentation: + +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox + +

+
+ + + +## :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. + +
Automated Project creation (for unlimited projects) + New projects are created, simply by adding a new directory (vhost, ssl, dns records are all zero-conf) +
+
Automated Reverse Proxy integration + Each project can specify its own **`http`** or **`https`** Reverse Proxy +
+
Automated Websocket Proxy integration + Each project can specify its own **`ws`** or **`wss`** Websocket Reverse Proxy +
+
Automated valid Browser HTTPS + HTTPS vhosts certs are created automatically and signed by bundled CA, which needs to be imported once +
+
Automated DNS + The bundled DNS server ensures that DNS records are always available for each project (zero-conf) +
+
Unlimited Projects + You can have as many projects as you want +
+
Different PHP versions per Project + Each project can be run with a different PHP version +
+
Different Remote Backends per Project (Node, Python, Golang, etc) + Each project can be powered by a different Remote Backend (e.g. **Node**, **Golang**, **Python**, etc) +
+
Custom Project Domains + Choose any development domain you desire: `.loc`, `.local`, `.dev` or even real domains `.example.com` +
+
Inter-Project communication + Each project can communicate with any other project (e.g.: Make API requests like in a microservice landscape) +
+
Email Interceptor + All outbound emails are intercepted and shown in the Intranet to not accidentally reach real domains +
+
Profiling and Debugging + Xdebug and other profiling tools are available by default. +
+
Devilbox Intranet + Devilbox Intranet shows the currently applied stack, projects, emails, configuration and customizations. + It Bundles Adminer, phpMyAdmin, phpPgAdmin, phpRedmin, phpMemcached OPCache Gui and many more +
+
Self-validation and full customization +
+
File ownership and permission sync +
+
Extendable with custom docker images +
+
All major developer tools included +
+
All major frameworks supported +
+ + + +

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. + +

💻 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) + +
+ + +

👷 Architecture

 @@ -86,10 +383,10 @@ have a look at the following diagrams and tables.
+
-> [Devilbox artwork](https://github.com/devilbox/artwork) -#### 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. @@ -103,117 +400,20 @@ Each of them is also available in multiple different versions in order to reflec | | | | PerconaDB | Redis | | Kibana | MailHog | | | | | PostgreSQL | | | | Ngrok | +
+ > **Documentation:** > [Available Container](https://devilbox.readthedocs.io/en/latest/readings/available-container.html) -## 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](https://devilbox.readthedocs.io)**, 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](https://discord.gg/2wP3V6kBj4)** or visit the **[forums](https://devilbox.discourse.group)** and get community support quickly. - - - - - - - - - - - - - - - - - - - - - - - - -

📘 Docs

🎮 Discord

🗪 Forum

🔥 Flames

- - - - - - - - - - - - - - - -
devilbox.readthedocs.iodiscord/devilboxdevilbox.discourse.groupgithub.com/devilbox/flames
- -## Usage - -#### Quick start - - - - - - - - - - - - - - -
Linux and MacOSWindows
-
# 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](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) - -#### 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. - -```bash -docker-compose up httpd php mysql redis -``` -> **Documentation:** -> [Start only some container](https://devilbox.readthedocs.io/en/latest/getting-started/start-the-devilbox.html#start-some-container) - -![Devilbox](docs/img/devilbox-dash-selective.png) - -#### Run different versions +

📌 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 + @@ -389,6 +589,7 @@ Every single attachable container comes with many different versions. In order t
+
[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. @@ -462,263 +663,15 @@ Additionally to the default stack, there are a variety of other services that ca +
+ > **Documentation:** > [Enable custom container](https://devilbox.readthedocs.io/en/latest/custom-container/enable-all-container.html) -#### 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 MacOSWindows
-
host> ./shell.sh
-devilbox@php-7.0.19 in /shared/httpd $
- 		-
C:\devilbox> shell.bat
-devilbox@php-7.0.19 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](https://devilbox.readthedocs.io/en/latest/intermediate/work-inside-the-php-container.html) | -> [Directory overview](https://devilbox.readthedocs.io/en/latest/getting-started/directory-overview.html) - -#### Quick Video intro - -[![Devilbox setup and workflow](docs/img/devilbox_01-setup-and-workflow.png "devilbox - setup and workflow")](https://www.youtube.com/watch?v=reyZMyt2Zzo) -[![Devilbox email catch-all](docs/img/devilbox_02-email-catch-all.png "devilbox - email catch-all")](https://www.youtube.com/watch?v=e-U-C5WhxGY) - -## Feature overview - -The Devilbox has everything setup for you. The only thing you will have to install is [Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://docs.docker.com/compose/install/). Virtual hosts and DNS entries will be created automatically, just by adding new project folders. - -> **Documentation:** -> [Devilbox Prerequisites](https://devilbox.readthedocs.io/en/latest/getting-started/prerequisites.html) - -#### Features - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
:star: HTTPS supportHTTPS is available by default for all projects and the bundled Intranet.
:star: HTTP/2 supportAll HTTPS connections will offer HTTP/2 as the default protocol, except for Apache 2.2 which does not support it.
:star: Auto virtual hostsNew virtual hosts are created automatically and instantly whenever you add a project directory. This is done internally via vhost-gen and watcherd.
:star: Automated SSL certsValid SSL certificates for HTTPS are automatically created for each vhost and signed by the Devilbox CA.
:star: Unlimited vhostsRun as many projects as you need with a single instance of the Devilbox.
:star: Custom vhostsYou can overwrite and customise the default applied vhost configuration for every single vhost.
:star: Reverse proxyHave your NodeJS application served with a nice domain name and valid HTTPS.
:star: Custom domainsChoose whatever development domain you desire: *.loc, *.dev or use real domains as well: *.example.com
:star: Auto DNSAn integrated BIND server is able to create DNS entries automatically for your chosen domains.
:star: Auto start scriptsCustom 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.
:star: Custom PHP configOverwrite any setting for PHP.
:star: Email catch-allAll outgoing emails are catched and will be presented in the included intranet.
:star: Self-validationProjects and configuration options are validated and marked in the intranet.
:star: XdebugXdebug and a full blown PHP-FPM server is ready to serve.
:star: Devilbox FlamesDevilbox community plugins a.k.a. Devilbox Flames.
:star: Many moreSee Documentation for all available features.
- -> **Documentation:** -> [Setup Auto DNS](https://devilbox.readthedocs.io/en/latest/intermediate/setup-auto-dns.html) | -> [Setup valid HTTPS](https://devilbox.readthedocs.io/en/latest/intermediate/setup-valid-https.html) | -> [Configure Xdebug](https://devilbox.readthedocs.io/en/latest/intermediate/configure-php-xdebug.html) | -> [Customize PHP](https://devilbox.readthedocs.io/en/latest/advanced/customize-php-globally.html) - -#### Batteries - -The following batteries are available in the Devilbox intranet by default: - - - - - - - - - - - - - - - - - - - - - - -
AdminerphpMyAdminphpPgAdminphpRedMinPHPMemcachedAdminOpCacheGUIMail viewer
AdminerphpMyAdminphpPgAdminphpRedMinPHP Memcached AdminOpCache GUIMail viewer
- -> **Documentation:** -> [Devilbox Intranet](https://devilbox.readthedocs.io/en/latest/getting-started/devilbox-intranet.html) - -#### Tools - -The following tools will assist you on creating new projects easily as well as helping you check your code against guidelines. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
:wrench: awesome-ciA 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
:wrench: git flowgit-flow is a Git extensions to provide high-level repository operations for Vincent Driessen's branching model.
:wrench: json lintjsonlint is a command line linter for JSON files.
:wrench: laravel installerlaravel is a command line tool that lets you easily install the Laravel framework.
:wrench: linkchecklinkcheck is a command line tool that searches for URLs in files (optionally limited by extension) and validates their HTTP status code.
:wrench: markdownlintmarkdownlint is a markdown linter.
:wrench: mdlmdl is a markdown linter.
:wrench: phalcon devtoolsphalcon is a command line tool that lets you easily install the PhalconPHP framework.
:wrench: photon installerphoton is a command line tool that lets you easily install the PhotonCMS.
:wrench: php code snifferphpcs is a command line tool that tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
:wrench: php code beautifierphpcbf is a command line tool that automatically correct coding standard violations.
:wrench: php cs fixerphp-cs-fixer is a tool to automatically fix PHP Coding Standards issues.
:wrench: pm2pm2 is Node.js Production Process Manager with a built-in Load Balancer.
:wrench: stylelintstylelint is a css/scss linter.
:wrench: symfony installersymfony is a command line tool that lets you easily install the Symfony framework.
:wrench: tigtig is a text-mode interface for git.
:wrench: wp-cliwp is a command line tool that lets you easily install WordPress.
:wrench: yamllintyamllint is a linter for yaml files.
- -Well-known and popular tools will be at your service as well: - -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox -Devilbox - -> **Documentation:** -> [Available Tools](https://devilbox.readthedocs.io/en/latest/readings/available-tools.html) - -#### Available PHP Modules +

⚙️ 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. @@ -726,6 +679,8 @@ The Devilbox is a development stack, so it is made sure that a lot of PHP module > * 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 | |-------------------------------|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:| @@ -837,15 +792,159 @@ The Devilbox is a development stack, so it is made sure that a lot of PHP module | 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 Tools

 + +Well-known and popular tools will be at your service: + +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox +Devilbox + + + + +| 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 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: @@ -904,25 +1003,55 @@ starts up as soon as you run `docker-compose up`. > [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) -## Intranet overview +
+ + +

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) -* **Database overview** (MySQL, PgSQL, Redis, Memcache, ...) +* **Command & Control** * **Email overview** +* **Database overview** (MySQL, PgSQL, Redis, Memcache, ...) * **Info pages** (Httpd, MySQL, PgSQL, Redis, Memcache, ...) -* **[Adminer](https://www.adminer.org)** -* **[phpMyAdmin](https://www.phpmyadmin.net)** -* **[phpPgAdmin](http://phppgadmin.sourceforge.net)** -* **[phpRedMin](https://github.com/sasanrose/phpredmin)** -* **[PHPMemcachedAdmin](https://github.com/elijaa/phpmemcachedadmin)** -* **[OpcacheGUI](https://github.com/PeeHaa/OpCacheGUI)** +* And many more... + +
+ +The following batteries are available in the Devilbox intranet by default: + + + + + + + + + + + + + + + + + + + + + + +
AdminerphpMyAdminphpPgAdminphpRedMinPHPMemcachedAdminOpCacheGUIMail viewer
AdminerphpMyAdminphpPgAdminphpRedMinPHP Memcached AdminOpCache GUIMail viewer
+
> **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. @@ -946,12 +1075,69 @@ A few examples of how the built-in intranet looks like. +
-## Contributing [![Open Source Helpers](https://www.codetriage.com/cytopia/devilbox/badges/users.svg)](https://www.codetriage.com/cytopia/devilbox) + + +## 👫 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](https://devilbox.readthedocs.io)**, 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](https://discord.gg/2wP3V6kBj4)** or visit the **[forums](https://devilbox.discourse.group)** and get community support quickly. + + + + + + + + + + + + + + + + + + + + + + + + +

📘 Docs

🎮 Discord

🗪 Forum

🔥 Flames

+ + + + + + + + + + + + + + + +
devilbox.readthedocs.iodiscord/devilboxdevilbox.discourse.groupgithub.com/devilbox/flames
+ + + +## 🤝 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 @@ -969,16 +1157,17 @@ To increase visibility and bug-free operation: * Visit the [Devilbox Discord Chat](https://discord.gg/2wP3V6kBj4) to exchange about setups * Visit the [Devilbox Community Forums](https://devilbox.discourse.group) for announcements and to help others -Additionally you can [subscribe to Devilbox on CodeTriage](https://www.codetriage.com/cytopia/devilbox), -read up on [CONTRIBUTING.md](CONTRIBUTING.md) and check the [ROADMAP](https://github.com/cytopia/devilbox/issues/23) about what is already planned for the near future. -## Logos + +## 🌀 Logos Logos and banners can be found at **[devilbox/artwork](https://github.com/devilbox/artwork)**. Feel free to use or modify them by the terms of their license. -## License + + +## 🗎 License **[MIT License](LICENSE.md)**